diff --git a/_data/reference.yml b/_data/reference.yml index 3aa495c9026b8..883e0efd26c28 100644 --- a/_data/reference.yml +++ b/_data/reference.yml @@ -26,6 +26,8 @@ toc: - title: API Reference section: + - title: v1.8 + path: /docs/api-reference/v1.8/ - title: v1.7 path: /docs/api-reference/v1.7/ - title: v1.6 @@ -52,6 +54,8 @@ toc: - title: kubectl CLI section: - docs/user-guide/kubectl-overview.md + - title: v1.8 Commands + path: /docs/user-guide/kubectl/v1.8/ - title: v1.7 Commands path: /docs/user-guide/kubectl/v1.7/ - title: v1.6 Commands diff --git a/docs/api-reference/v1.8/LICENSE b/docs/api-reference/v1.8/LICENSE new file mode 100644 index 0000000000000..8dada3edaf50d --- /dev/null +++ b/docs/api-reference/v1.8/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/docs/api-reference/v1.8/README.md b/docs/api-reference/v1.8/README.md new file mode 100644 index 0000000000000..f6799c18b9437 --- /dev/null +++ b/docs/api-reference/v1.8/README.md @@ -0,0 +1,69 @@ +## Synopsis + +Static compilation of html from markdown including processing for grouping code snippets into arbitrary tabs. + +## Code Example + +\> bdocs-tab:kubectl Deployment Config to run 3 nginx instances (max rollback set to 10 revisions). + +bdocs-tab:tab will be stripped during rendering and utilized to with CSS to show or hide the prefered tab. kubectl indicates the desired tab, since blockquotes have no specific syntax highlighting. + +\`\`\`bdocs-tab:kubectl_yaml +apiVersion: extensions/v1beta1 +kind: Deployment +metadata: + name: deployment-example +spec: + replicas: 3 + revisionHistoryLimit: 10 + template: + metadata: + labels: + app: nginx + spec: + containers: + - name: nginx + image: nginx:1.10 +\`\`\` + +bdocs-tab:tab_lang will be used to indicate which tab these code snippets belong to. The tab section of the string indicates the tab, while, the language is pushed beyond the underscore. During rendering, the language will be properly highlighted as if the bdoc token was omitted. + +## Motivation + +This is a project to extend markdown documents and render them in html with a table of contents and code snippet pane. Most projects of this variety lean heavily on front end parsing with JavaScript/jQuery. This project uses NodeJS, Marked, and highlight.js to output syntax highlighted code blocks. + +With specific tokens on blockquotes and code blocks, the chunks can be placed according to their relevance. Ex: Multiple language code blocks that should be grouped under an arbitrary tab. + +## Installation + +Clone the repository, then add documents into documents directory. Modify the manifest.json to contain the document filenames in the order desired. The docs field is an array of objects with a filename key. + +As a NodeJS program, a valid installation of node is required. Once node is installed, verify it can be run from command line. +``` +node --version +``` +Next, depedencies need to be installed via npm from the root of the project directory. +``` +npm install +``` + +Once dependencies are installed, run +``` +node brodoc.js +``` + +This will generate the index.html file, which can be opened in a browser or served. + +The included node-static server can be run from the project root via +``` +npm start +``` + +## License + +Apache License Version 2.0 + +## FAQ + +Q: Why is it named brodocs? +A: This project was born out of a collaboration with my brother to create a suitable docs app for his purposes. It was a fun name for the the two of us to use as actual brothers. \ No newline at end of file diff --git a/docs/api-reference/v1.8/actions.js b/docs/api-reference/v1.8/actions.js new file mode 100644 index 0000000000000..ce2b504b9e034 --- /dev/null +++ b/docs/api-reference/v1.8/actions.js @@ -0,0 +1,58 @@ +// https://jsfiddle.net/upqwhou2/ + +$(document).ready(function() { + var navigationLinks = $('#sidebar-wrapper > ul li a'); + var navigationSections = $('#sidebar-wrapper > ul > ul'); + var sectionIdTonavigationLink = {}; + var sections = $('#page-content-wrapper').find('h1, h2').map(function(index, node) { + if (node.id) { + sectionIdTonavigationLink[node.id] = $('#sidebar-wrapper > ul li a[href="#' + node.id + '"]'); + return node; + } + }); + var sectionIdToNavContainerLink = {}; + var topLevelSections = $('#page-content-wrapper').find('h1').map(function(index, node) { + if (node.id) { + sectionIdToNavContainerLink[node.id] = $('#sidebar-wrapper > ul > ul[id="' + node.id + '-nav' +'"]'); + return node; + } + }); + + var firstLevelNavs = $('#sidebar-wrapper > li'); + var secondLevelNavs = $('#sidebar-wrapper > ul > ul'); + var secondLevelNavContents = $('#sidebar-wrapper > ul > ul > li'); + var thirdLevelNavs = null; // TODO: When compile provides 3 level nav, implement + + var sectionsReversed = $(sections.get().reverse()); + + function checkScroll(event) { + var scrollPosition = $(window).scrollTop(); + var offset = 50; + scrollPosition += offset; + sections.each(function() { + var currentSection = $(this); + var sectionTop = $(this).offset().top; + var id = $(this).attr('id'); + if (scrollPosition >= sectionTop) { + navigationLinks.removeClass('selected'); + sectionIdTonavigationLink[id].addClass('selected'); + var sectionNavContainer = sectionIdToNavContainerLink[id]; + var sectionNavContainerDisplay; + if (sectionNavContainer) { + sectionNavContainerDisplay = sectionNavContainer.css('display'); + } + if (sectionNavContainer && sectionNavContainerDisplay === 'none') { + navigationSections.toggle(false); + sectionNavContainer.toggle(true); + } + } + if (($(this).offset().top < window.pageYOffset + 50) && $(this).offset().top + $(this).height() > window.pageYOffset) { + window.location.hash = id; + } + }); + } + checkScroll(); + $(window).on('scroll', function(event) { + checkScroll(event); + }); +}); \ No newline at end of file diff --git a/docs/api-reference/v1.8/brodoc.js b/docs/api-reference/v1.8/brodoc.js new file mode 100644 index 0000000000000..63b222b5168de --- /dev/null +++ b/docs/api-reference/v1.8/brodoc.js @@ -0,0 +1,211 @@ +const docFolder = './documents/'; +const fs = require('fs'); +const marked = require('marked'); +const highlight = require('highlight.js'); +const renderer = new marked.Renderer(); +const brodocDec = require('./markedDecorations.js'); + + +marked.setOptions({ + renderer: renderer, + gfm: true, + tables: true, + breaks: false, + pedantic: false, + sanitize: false, + smartLists: true, + smartypants: false, + highlight: function (code, lang) { + return highlight.highlightAuto(code).value; + } +}); +brodocDec.decorateMarked(renderer); + +var config = require('./manifest'); +var docs = config.docs; + +var files = []; +var fileArray = []; +docs.forEach(file => { + files.push(file.filename); + fileArray.push(file); +}); + +var bodyContent = ''; +var navIds = brodocDec.navIds; +var codeTabs = brodocDec.codeTabs; + + +// const lexer = new marked.Lexer(); +// lexer.rules.bdoc = /^(\/{4} )(\w+).*$/; + +var path = docFolder; +var fIndex = 0; +var rIndex = 0; +var fileObj = {toc: [], content: [], tabs: []}; +fileArray.forEach((file, index) => { + fs.readFile(path + file.filename, 'utf8', (err, data) => { + rIndex++; + file.content = data; + + if (rIndex >= files.length) { + // do the things + parseFileContent(fileArray); + var navData = generateNavItems(navIds); + var navContent = navData.content; + var navDataArray = navData.navDataArray; + var codeTabContent = generateCodeTabItems(codeTabs); + var bodyContent = flattenContent(parsedContentArray); + generateDoc(navContent, bodyContent, codeTabContent); + generateNavJson(navDataArray); + } + }); +}); + +function flattenContent(content) { + var flattenedContent = content.reduce(function(accum, val) { + return accum + val; + }); + return flattenedContent; +} + +var parsedContentArray = []; +function parseFileContent(files) { + files.forEach((file, index) => { + parsedContentArray[index] = parseDoc(file.content); + }); +} +function parseDoc(doc) { + return marked(doc, { renderer: renderer }); +} + +function generateNavItems(navObjs) { + var reversedNavs = navObjs.reverse(); + var currentNestArray = []; + var currentStrongArray = []; + var flattenedNest = ''; + var nestedNavArray = []; // Array containing generated html menu items - is flattened into a string. + var navArrayInvert = []; // Deals with data layer of navigation; + var navSectionArray = []; + var navStrongSectionArray = []; + var navSectionArrayClone; + var flatNavArrayInvert = []; + reversedNavs.forEach(obj => { + flatNavArrayInvert.push(obj.id); + var strong = (obj.id.indexOf('-strong-') !== -1); + if (obj.level !== 1) { + if (strong && currentNestArray.length !== 0) { + flattenedNest = flattenContent(currentNestArray.reverse()); + currentStrongArray.push(generateNestedNav(obj, flattenedNest)); + currentNestArray.length = 0; + + navSectionArrayClone = Object.assign([], navSectionArray); + navStrongSectionArray.push({section: obj.id, subsections: navSectionArrayClone}); + navSectionArray.length = 0; + } else { + currentNestArray.push(generateNav(obj)); + navSectionArray.push({section: obj.id}); + } + } else if (obj.level === 1) { + if (currentStrongArray.length !== 0) { + currentNestArray.forEach(obj => { + currentStrongArray.push(obj); + }); + flattenedNest = flattenContent(currentStrongArray.reverse()); + } else if (currentNestArray.length !== 0) { + flattenedNest = flattenContent(currentNestArray.reverse()); + } + nestedNavArray.push(generateNestedNav(obj, flattenedNest)); + currentNestArray.length = 0; + currentStrongArray.length = 0; + flattenedNest = ''; + + navSectionArray.forEach(obj => { + navStrongSectionArray.push(obj); + }); + navSectionArrayClone = Object.assign([], navStrongSectionArray); + navStrongSectionArray.length = 0; + navArrayInvert.push({section: obj.id, subsections: navSectionArrayClone}); + navSectionArray.length = 0; + } + }); + + var navContent = flattenContent(nestedNavArray.reverse()); + return {content: navContent, navDataArray: {toc: navArrayInvert, flatToc: flatNavArrayInvert}}; +} + +function generateNav(obj) { + var classString = 'nav-level-' + obj.level; + var isStrong = obj.id.indexOf('-strong-') !== -1; + if (isStrong) { + classString += ' strong-nav'; + } + return '
Welcome to the Kubernetes API. You can use the Kubernetes API to read +and write Kubernetes resource objects via a Kubernetes API endpoint.
+This is a high-level overview of the basic types of resources provide by the Kubernetes API and their primary functions.
+Workloads are objects you use to manage and run your containers on the cluster.
+Discovery & LB resources are objects you use to "stitch" your workloads together into an externally accessible, load-balanced Service.
+Config & Storage resources are objects you use to inject initialization data into your applications, and to persist data that is external to your container.
+Cluster resources objects define how the cluster itself is configured; these are typically used only by cluster operators.
+Metadata resources are objects you use to configure the behavior of other resources within the cluster, such as HorizontalPodAutoscaler for scaling workloads.
+Resource objects typically have 3 components:
+Most resources provide the following Operations:
+Create operations will create the resource in the storage backend. After a resource is create the system will apply +the desired state.
+Updates come in 2 forms: Replace and Patch
+Replace: +Replacing a resource object will update the resource by replacing the existing spec with the provided one. For +read-then-write operations this is safe because an optimistic lock failure will occur if the resource was modified +between the read and write. Note: The ResourceStatus will be ignored by the system and will not be updated. +To update the status, one must invoke the specific status update operation.
+Note: Replacing a resource object may not result immediately in changes being propagated to downstream objects. For instance +replacing a ConfigMap or Secret resource will not result in all Pods seeing the changes unless the Pods are +restarted out of band.
+Patch: +Patch will apply a change to a specific field. How the change is merged is defined per field. Lists may either be +replaced or merged. Merging lists will not preserve ordering.
+Patches will never cause optimistic locking failures, and the last write will win. Patches are recommended + when the full state is not read before an update, or when failing on optimistic locking is undesirable. When patching + complex types, arrays and maps, how the patch is applied is defined on a per-field basis and may either replace + the field's current value, or merge the contents into the current value.
+Reads come in 3 forms: Get, List and Watch
+Get: Get will retrieve a specific resource object by name.
+List: List will retrieve all resource objects of a specific type within a namespace, and the results can be restricted to resources matching a selector query.
+List All Namespaces: Like List but retrieves resources across all namespaces.
+Watch: Watch will stream results for an object(s) as it is updated. Similar to a callback, watch is used to respond to resource changes.
+Delete will delete a resource. Depending on the specific resource, child objects may or may not be garbage collected by the server. See +notes on specific resource objects for details.
+Resources may define additional operations specific to that resource type.
+Rollback: Rollback a PodTemplate to a previous version. Only available for some resource types.
+Read / Write Scale: Read or Update the number of replicas for the given resource. Only available for some resource types.
+Read / Write Status: Read or Update the Status for a resource object. The Status can only changed through these update operations.
+Worloads resources are responsible for managing and running your containers on the cluster. Containers are created +by Controllers through Pods. Pods run Containers and provide environmental dependencies such as shared or +persistent storage Volumes and Configuration or Secret data injected into the +container.
+The most common Controllers are:
+++Container Config to run nginx (must be embedded in a PodSpec to run).
+
+name: nginx
+# Run the nginx:1.10 image
+image: nginx:1.10
+
+++Container Config to run nginx (must be embedded in a PodSpec to run).
+
+name: nginx
+# Run the nginx:1.10 image
+image: nginx:1.10
+
+Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +Container | +
A single application container that you want to run within a pod.
+ + +Field | +Description | +
---|---|
args string array |
+Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell | +
command string array |
+Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell | +
env EnvVar array patch type: merge patch merge key: name |
+List of environment variables to set in the container. Cannot be updated. | +
envFrom EnvFromSource array |
+List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. | +
image string |
+Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. | +
imagePullPolicy string |
+Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images | +
lifecycle Lifecycle |
+Actions that the management system should take in response to container lifecycle events. Cannot be updated. | +
livenessProbe Probe |
+Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes | +
name string |
+Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. | +
ports ContainerPort array patch type: merge patch merge key: containerPort |
+List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. | +
readinessProbe Probe |
+Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes | +
resources ResourceRequirements |
+Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources | +
securityContext SecurityContext |
+Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://git.k8s.io/community/contributors/design-proposals/security_context.md | +
stdin boolean |
+Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. | +
stdinOnce boolean |
+Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false | +
terminationMessagePath string |
+Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. | +
terminationMessagePolicy string |
+Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. | +
tty boolean |
+Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. | +
volumeMounts VolumeMount array patch type: merge patch merge key: mountPath |
+Pod volumes to mount into the container's filesystem. Cannot be updated. | +
workingDir string |
+Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. | +
Field | +Description | +
---|---|
containerID string |
+Container's ID in the format 'docker:// |
+
image string |
+The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images | +
imageID string |
+ImageID of the container's image. | +
lastState ContainerState |
+Details about the container's last termination condition. | +
name string |
+This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated. | +
ready boolean |
+Specifies whether the container has passed its readiness probe. | +
restartCount integer |
+The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC. | +
state ContainerState |
+Details about the container's current condition. | +
Group | +Version | +Kind | +
---|---|---|
batch | +v1beta1 | +CronJob | +
CronJob represents the configuration of a single cron job.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec CronJobSpec |
+Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
status CronJobStatus |
+Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
Field | +Description | +
---|---|
concurrencyPolicy string |
+Specifies how to treat concurrent executions of a Job. Defaults to Allow. | +
failedJobsHistoryLimit integer |
+The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. | +
jobTemplate JobTemplateSpec |
+Specifies the job that will be created when executing a CronJob. | +
schedule string |
+The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. | +
startingDeadlineSeconds integer |
+Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. | +
successfulJobsHistoryLimit integer |
+The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3. | +
suspend boolean |
+This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false. | +
Field | +Description | +
---|---|
active ObjectReference array |
+A list of pointers to currently running jobs. | +
lastScheduleTime Time |
+Information when was the last time the job was successfully scheduled. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items CronJob array |
+items is the list of CronJobs. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a CronJob
+POST /apis/batch/v1beta1/namespaces/{namespace}/cronjobs
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body CronJob |
++ |
Code | +Description | +
---|---|
200 CronJob |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified CronJob
+PATCH /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}
Parameter | +Description | +
---|---|
name | +name of the CronJob | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 CronJob |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified CronJob
+PUT /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}
Parameter | +Description | +
---|---|
name | +name of the CronJob | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body CronJob |
++ |
Code | +Description | +
---|---|
200 CronJob |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a CronJob
+DELETE /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}
Parameter | +Description | +
---|---|
name | +name of the CronJob | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of CronJob
+DELETE /apis/batch/v1beta1/namespaces/{namespace}/cronjobs
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified CronJob
+GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}
Parameter | +Description | +
---|---|
name | +name of the CronJob | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 CronJob |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind CronJob
+GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 CronJobList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind CronJob
+GET /apis/batch/v1beta1/cronjobs
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 CronJobList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind CronJob
+GET /apis/batch/v1beta1/watch/namespaces/{namespace}/cronjobs/{name}
Parameter | +Description | +
---|---|
name | +name of the CronJob | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of CronJob
+GET /apis/batch/v1beta1/watch/namespaces/{namespace}/cronjobs
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of CronJob
+GET /apis/batch/v1beta1/watch/cronjobs
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update status of the specified CronJob
+PATCH /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status
Parameter | +Description | +
---|---|
name | +name of the CronJob | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 CronJob |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read status of the specified CronJob
+GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status
Parameter | +Description | +
---|---|
name | +name of the CronJob | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 CronJob |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified CronJob
+PUT /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status
Parameter | +Description | +
---|---|
name | +name of the CronJob | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body CronJob |
++ |
Code | +Description | +
---|---|
200 CronJob |
+OK | +
++DaemonSet Config to print the
+hostname
on each Node in the cluster every 10 seconds.
+apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+ # Unique key of the DaemonSet instance
+ name: daemonset-example
+spec:
+ template:
+ metadata:
+ labels:
+ app: daemonset-example
+ spec:
+ containers:
+ # This container is run once on each Node in the cluster
+ - name: daemonset-example
+ image: ubuntu:trusty
+ command:
+ - /bin/sh
+ args:
+ - -c
+ # This script is run through `sh -c <script>`
+ - >-
+ while [ true ]; do
+ echo "DaemonSet running on $(hostname)" ;
+ sleep 10 ;
+ done
+
+++DaemonSet Config to print the
+hostname
on each Node in the cluster every 10 seconds.
+apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+ # Unique key of the DaemonSet instance
+ name: daemonset-example
+spec:
+ template:
+ metadata:
+ labels:
+ app: daemonset-example
+ spec:
+ containers:
+ # This container is run once on each Node in the cluster
+ - name: daemonset-example
+ image: ubuntu:trusty
+ command:
+ - /bin/sh
+ args:
+ - -c
+ # This script is run through `sh -c <script>`
+ - >-
+ while [ true ]; do
+ echo "DaemonSet running on $(hostname)" ;
+ sleep 10 ;
+ done
+
+Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +DaemonSet | +
DEPRECATED - This group version of DaemonSet is deprecated by apps/v1beta2/DaemonSet. See the release notes for more information. DaemonSet represents the configuration of a daemon set.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec DaemonSetSpec |
+The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
status DaemonSetStatus |
+The current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
Field | +Description | +
---|---|
minReadySeconds integer |
+The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready). | +
revisionHistoryLimit integer |
+The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. | +
selector LabelSelector |
+A label query over pods that are managed by the daemon set. Must match in order to be controlled. If empty, defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | +
template PodTemplateSpec |
+An object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template | +
templateGeneration integer |
+DEPRECATED. A sequence number representing a specific generation of the template. Populated by the system. It can be set only during the creation. | +
updateStrategy DaemonSetUpdateStrategy |
+An update strategy to replace existing DaemonSet pods with new pods. | +
Field | +Description | +
---|---|
collisionCount integer |
+Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision. | +
currentNumberScheduled integer |
+The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ | +
desiredNumberScheduled integer |
+The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ | +
numberAvailable integer |
+The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds) | +
numberMisscheduled integer |
+The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ | +
numberReady integer |
+The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready. | +
numberUnavailable integer |
+The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds) | +
observedGeneration integer |
+The most recent generation observed by the daemon set controller. | +
updatedNumberScheduled integer |
+The total number of nodes that are running updated daemon pod | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items DaemonSet array |
+A list of daemon sets. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
Field | +Description | +
---|---|
maxUnavailable | +The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0. Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update. | +
See supported operations below...
++++
kubectl
Command
+$ echo 'apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+ name: daemonset-example
+spec:
+ template:
+ metadata:
+ labels:
+ app: daemonset-example
+ spec:
+ containers:
+ - name: daemonset-example
+ image: ubuntu:trusty
+ command:
+ - /bin/sh
+ args:
+ - -c
+ - >-
+ while [ true ]; do
+ echo "DaemonSet running on $(hostname)" ;
+ sleep 10 ;
+ done
+' | kubectl create -f -
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+ name: daemonset-example
+spec:
+ template:
+ metadata:
+ labels:
+ app: daemonset-example
+ spec:
+ containers:
+ - name: daemonset-example
+ image: ubuntu:trusty
+ command:
+ - /bin/sh
+ args:
+ - -c
+ - >-
+ while [ true ]; do
+ echo "DaemonSet running on $(hostname)" ;
+ sleep 10 ;
+ done
+' http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/daemonsets
+
+++Output
+
+daemonset "daemonset-example" created
+
+++Response Body
+
+{
+ "kind": "DaemonSet",
+ "apiVersion": "extensions/v1beta1",
+ "metadata": {
+ "name": "daemonset-example",
+ "namespace": "default",
+ "selfLink": "/apis/extensions/v1beta1/namespaces/default/daemonsets/daemonset-example",
+ "uid": "65552ced-b0e2-11e6-aef0-42010af00229",
+ "resourceVersion": "3558",
+ "generation": 1,
+ "creationTimestamp": "2016-11-22T18:35:09Z",
+ "labels": {
+ "app": "daemonset-example"
+ }
+ },
+ "spec": {
+ "selector": {
+ "matchLabels": {
+ "app": "daemonset-example"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "daemonset-example"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "daemonset-example",
+ "image": "ubuntu:trusty",
+ "command": [
+ "/bin/sh"
+ ],
+ "args": [
+ "-c",
+ "while [ true ]; do echo \"DaemonSet running on $(hostname)\" ; sleep 10 ; done"
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ }
+ },
+ "status": {
+ "currentNumberScheduled": 0,
+ "numberMisscheduled": 0,
+ "desiredNumberScheduled": 0
+ }
+}
+
+create a DaemonSet
+POST /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body DaemonSet |
++ |
Code | +Description | +
---|---|
200 DaemonSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified DaemonSet
+PATCH /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}
Parameter | +Description | +
---|---|
name | +name of the DaemonSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 DaemonSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified DaemonSet
+PUT /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}
Parameter | +Description | +
---|---|
name | +name of the DaemonSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body DaemonSet |
++ |
Code | +Description | +
---|---|
200 DaemonSet |
+OK | +
+++
kubectl
Command
+$ kubectl delete daemonset daemonset-example
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/daemonsets/daemonset-example'
+
+++Output
+
+daemonset "daemonset-example" deleted
+
+++Response Body
+
+{
+ "kind": "Status",
+ "apiVersion": "v1",
+ "metadata": {},
+ "status": "Success",
+ "code": 200
+}
+
+delete a DaemonSet
+DELETE /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}
Parameter | +Description | +
---|---|
name | +name of the DaemonSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of DaemonSet
+DELETE /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+$ kubectl get daemonset daemonset-example -o json
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X GET http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/daemonsets/daemonset-example
+
+++Output
+
+
+++Response Body
+
+
+read the specified DaemonSet
+GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}
Parameter | +Description | +
---|---|
name | +name of the DaemonSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 DaemonSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind DaemonSet
+GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 DaemonSetList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind DaemonSet
+GET /apis/extensions/v1beta1/daemonsets
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 DaemonSetList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind DaemonSet
+GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/daemonsets/{name}
Parameter | +Description | +
---|---|
name | +name of the DaemonSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of DaemonSet
+GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/daemonsets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of DaemonSet
+GET /apis/extensions/v1beta1/watch/daemonsets
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update status of the specified DaemonSet
+PATCH /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status
Parameter | +Description | +
---|---|
name | +name of the DaemonSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 DaemonSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read status of the specified DaemonSet
+GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status
Parameter | +Description | +
---|---|
name | +name of the DaemonSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 DaemonSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified DaemonSet
+PUT /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status
Parameter | +Description | +
---|---|
name | +name of the DaemonSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body DaemonSet |
++ |
Code | +Description | +
---|---|
200 DaemonSet |
+OK | +
++Deployment Config to run 3 nginx instances (max rollback set to 10 revisions).
+
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ # Unique key of the Deployment instance
+ name: deployment-example
+spec:
+ # 3 Pods should exist at all times.
+ replicas: 3
+ template:
+ metadata:
+ labels:
+ # Apply this label to pods and default
+ # the Deployment label selector to this value
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ # Run this image
+ image: nginx:1.10
+
+++Deployment Config to run 3 nginx instances (max rollback set to 10 revisions).
+
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ # Unique key of the Deployment instance
+ name: deployment-example
+spec:
+ # 3 Pods should exist at all times.
+ replicas: 3
+ template:
+ metadata:
+ labels:
+ # Apply this label to pods and default
+ # the Deployment label selector to this value
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ # Run this image
+ image: nginx:1.10
+
+Group | +Version | +Kind | +
---|---|---|
apps | +v1beta1 | +Deployment | +
DEPRECATED - This group version of Deployment is deprecated by apps/v1beta2/Deployment. See the release notes for more information. Deployment enables declarative updates for Pods and ReplicaSets.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object metadata. | +
spec DeploymentSpec |
+Specification of the desired behavior of the Deployment. | +
status DeploymentStatus |
+Most recently observed status of the Deployment. | +
Field | +Description | +
---|---|
minReadySeconds integer |
+Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) | +
paused boolean |
+Indicates that the deployment is paused. | +
progressDeadlineSeconds integer |
+The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s. | +
replicas integer |
+Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. | +
revisionHistoryLimit integer |
+The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 2. | +
rollbackTo RollbackConfig |
+DEPRECATED. The config this deployment is rolling back to. Will be cleared after rollback is done. | +
selector LabelSelector |
+Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. | +
strategy DeploymentStrategy |
+The deployment strategy to use to replace existing pods with new ones. | +
template PodTemplateSpec |
+Template describes the pods that will be created. | +
Field | +Description | +
---|---|
availableReplicas integer |
+Total number of available pods (ready for at least minReadySeconds) targeted by this deployment. | +
collisionCount integer |
+Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet. | +
conditions DeploymentCondition array patch type: merge patch merge key: type |
+Represents the latest available observations of a deployment's current state. | +
observedGeneration integer |
+The generation observed by the deployment controller. | +
readyReplicas integer |
+Total number of ready pods targeted by this deployment. | +
replicas integer |
+Total number of non-terminated pods targeted by this deployment (their labels match the selector). | +
unavailableReplicas integer |
+Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created. | +
updatedReplicas integer |
+Total number of non-terminated pods targeted by this deployment that have the desired template spec. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items Deployment array |
+Items is the list of Deployments. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. | +
Field | +Description | +
---|---|
rollingUpdate RollingUpdateDeployment |
+Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. | +
type string |
+Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
name string |
+Required: This must match the Name of a deployment. | +
rollbackTo RollbackConfig |
+The config of this deployment rollback. | +
updatedAnnotations object |
+The annotations to be updated to a deployment | +
Field | +Description | +
---|---|
maxSurge | +The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods. | +
maxUnavailable | +The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. | +
See supported operations below...
++++
kubectl
Command
+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.10
+ ports:
+ - containerPort: 80
+' | kubectl create -f -
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.10
+ ports:
+ - containerPort: 80
+' http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments
+
+++Output
+
+deployment "deployment-example" created
+
+++Response Body
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
+ "resourceVersion": "2118306",
+ "generation": 1,
+ "creationTimestamp": "2016-10-28T01:53:19Z",
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ },
+ "revisionHistoryLimit": 10
+ },
+ "status": {}
+}
+
+create a Deployment
+POST /apis/apps/v1beta1/namespaces/{namespace}/deployments
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Deployment |
++ |
Code | +Description | +
---|---|
200 Deployment |
+OK | +
+++
kubectl
Command
+$ kubectl patch deployment deployment-example -p \
+ '{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}'
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X PATCH -H 'Content-Type: application/strategic-merge-patch+json' --data '
+{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}' \
+ 'http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments/deployment-example'
+
+++Output
+
+"deployment-example" patched
+
+++Response Body
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "5dc3a8e6-b0ee-11e6-aef0-42010af00229",
+ "resourceVersion": "164489",
+ "generation": 11,
+ "creationTimestamp": "2016-11-22T20:00:50Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "5"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.11",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ },
+ "revisionHistoryLimit": 10
+ },
+ "status": {
+ "observedGeneration": 10,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+partially update the specified Deployment
+PATCH /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}
Parameter | +Description | +
---|---|
name | +name of the Deployment | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 Deployment |
+OK | +
+++
kubectl
Command
+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.11
+ ports:
+ - containerPort: 80
+' | kubectl replace -f -
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X PUT -H 'Content-Type: application/yaml' --data '
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.11
+ ports:
+ - containerPort: 80
+' http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments/deployment-example
+
+++Output
+
+deployment "deployment-example" replaced
+
+++Response Body
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
+ "resourceVersion": "2119082",
+ "generation": 5,
+ "creationTimestamp": "2016-10-28T01:53:19Z",
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.11",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ },
+ "revisionHistoryLimit": 10
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+replace the specified Deployment
+PUT /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}
Parameter | +Description | +
---|---|
name | +name of the Deployment | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Deployment |
++ |
Code | +Description | +
---|---|
200 Deployment |
+OK | +
+++
kubectl
Command
+$ kubectl delete deployment deployment-example
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments/deployment-example'
+
+++Output
+
+deployment "deployment-example" deleted
+
+++Response Body
+
+{
+ "kind": "Status",
+ "apiVersion": "v1",
+ "metadata": {},
+ "status": "Success",
+ "code": 200
+}
+
+delete a Deployment
+DELETE /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}
Parameter | +Description | +
---|---|
name | +name of the Deployment | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of Deployment
+DELETE /apis/apps/v1beta1/namespaces/{namespace}/deployments
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+$ kubectl get deployment deployment-example -o json
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X GET http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments/deployment-example
+
+++Output
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+++Response Body
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+read the specified Deployment
+GET /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}
Parameter | +Description | +
---|---|
name | +name of the Deployment | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 Deployment |
+OK | +
+++
kubectl
Command
+$ kubectl get deployment -o json
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments'
+
+++Output
+
+{
+ "kind": "List",
+ "apiVersion": "v1",
+ "metadata": {},
+ "items": [
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "docs",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
+ "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
+ "resourceVersion": "1924126",
+ "generation": 21,
+ "creationTimestamp": "2016-10-13T16:06:00Z",
+ "labels": {
+ "run": "docs"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "10",
+ "replicatingperfection.net/push-image": "true"
+ }
+ },
+ "spec": {
+ "replicas": 1,
+ "selector": {
+ "matchLabels": {
+ "run": "docs"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "auto-pushed-image-pwittrock/api-docs": "1477496453",
+ "run": "docs"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "docs",
+ "image": "pwittrock/api-docs:v9",
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 21,
+ "replicas": 1,
+ "updatedReplicas": 1,
+ "availableReplicas": 1
+ }
+ },
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+ ]
+}
+
+++Response Body
+
+{
+ "kind": "List",
+ "apiVersion": "v1",
+ "metadata": {},
+ "items": [
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "docs",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
+ "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
+ "resourceVersion": "1924126",
+ "generation": 21,
+ "creationTimestamp": "2016-10-13T16:06:00Z",
+ "labels": {
+ "run": "docs"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "10",
+ "replicatingperfection.net/push-image": "true"
+ }
+ },
+ "spec": {
+ "replicas": 1,
+ "selector": {
+ "matchLabels": {
+ "run": "docs"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "auto-pushed-image-pwittrock/api-docs": "1477496453",
+ "run": "docs"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "docs",
+ "image": "pwittrock/api-docs:v9",
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 21,
+ "replicas": 1,
+ "updatedReplicas": 1,
+ "availableReplicas": 1
+ }
+ },
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+ ]
+}
+
+list or watch objects of kind Deployment
+GET /apis/apps/v1beta1/namespaces/{namespace}/deployments
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 DeploymentList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind Deployment
+GET /apis/apps/v1beta1/deployments
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 DeploymentList |
+OK | +
+++
kubectl
Command
+$ kubectl get deployment deployment-example --watch -o json
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1beta1/watch/namespaces/default/deployments/deployment-example'
+
+++Output
+
+{
+ "type": "ADDED",
+ "object": {
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "64c12290-9cbf-11e6-9c54-42010a800148",
+ "resourceVersion": "2128095",
+ "generation": 2,
+ "creationTimestamp": "2016-10-28T03:34:12Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "3"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {
+ },
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {
+ }
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 2,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+}
+
+++Response Body
+
+{
+ "type": "ADDED",
+ "object": {
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "64c12290-9cbf-11e6-9c54-42010a800148",
+ "resourceVersion": "2128095",
+ "generation": 2,
+ "creationTimestamp": "2016-10-28T03:34:12Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "3"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {
+ },
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {
+ }
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 2,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+}
+
+watch changes to an object of kind Deployment
+GET /apis/apps/v1beta1/watch/namespaces/{namespace}/deployments/{name}
Parameter | +Description | +
---|---|
name | +name of the Deployment | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Deployment
+GET /apis/apps/v1beta1/watch/namespaces/{namespace}/deployments
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Deployment
+GET /apis/apps/v1beta1/watch/deployments
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update status of the specified Deployment
+PATCH /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Deployment | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 Deployment |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read status of the specified Deployment
+GET /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Deployment | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 Deployment |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified Deployment
+PUT /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Deployment | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Deployment |
++ |
Code | +Description | +
---|---|
200 Deployment |
+OK | +
++Job Config to print pi up to 2000 digits (then exit).
+
+apiVersion: batch/v1
+kind: Job
+metadata:
+ # Unique key of the Job instance
+ name: example-job
+spec:
+ template:
+ metadata:
+ name: example-job
+ spec:
+ containers:
+ - name: pi
+ image: perl
+ command: ["perl"]
+ args: ["-Mbignum=bpi", "-wle", "print bpi(2000)"]
+ # Do not restart containers after they exit
+ restartPolicy: Never
+
+++Job Config to print pi up to 2000 digits (then exit).
+
+apiVersion: batch/v1
+kind: Job
+metadata:
+ # Unique key of the Job instance
+ name: example-job
+spec:
+ template:
+ metadata:
+ name: example-job
+ spec:
+ containers:
+ - name: pi
+ image: perl
+ command: ["perl"]
+ args: ["-Mbignum=bpi", "-wle", "print bpi(2000)"]
+ # Do not restart containers after they exit
+ restartPolicy: Never
+
+Group | +Version | +Kind | +
---|---|---|
batch | +v1 | +Job | +
Job represents the configuration of a single job.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec JobSpec |
+Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
status JobStatus |
+Current status of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
Field | +Description | +
---|---|
activeDeadlineSeconds integer |
+Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer | +
backoffLimit integer |
+Specifies the number of retries before marking this job failed. Defaults to 6 | +
completions integer |
+Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ | +
manualSelector boolean |
+manualSelector controls generation of pod labels and pod selectors. Leave manualSelector unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see manualSelector=true in jobs that were created with the old extensions/v1beta1 API. More info: https://git.k8s.io/community/contributors/design-proposals/selector-generation.md |
+
parallelism integer |
+Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ | +
selector LabelSelector |
+A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | +
template PodTemplateSpec |
+Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ | +
Field | +Description | +
---|---|
active integer |
+The number of actively running pods. | +
completionTime Time |
+Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. | +
conditions JobCondition array patch type: merge patch merge key: type |
+The latest available observations of an object's current state. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ | +
failed integer |
+The number of pods which reached phase Failed. | +
startTime Time |
+Represents time when the job was acknowledged by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. | +
succeeded integer |
+The number of pods which reached phase Succeeded. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items Job array |
+items is the list of Jobs. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
See supported operations below...
++++
kubectl
Command
+$ echo 'apiVersion: batch/v1
+kind: Job
+metadata:
+ name: example-job
+spec:
+ template:
+ metadata:
+ name: example-job
+ spec:
+ containers:
+ - name: pi
+ image: perl
+ command: ["perl", "-Mbignum=bpi", "-wle", "print bpi(2000)"]
+ restartPolicy: Never
+' | kubectl create -f -
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+apiVersion: batch/v1
+kind: Job
+metadata:
+ name: example-job
+spec:
+ template:
+ metadata:
+ name: example-job
+ spec:
+ containers:
+ - name: pi
+ image: perl
+ command: ["perl", "-Mbignum=bpi", "-wle", "print bpi(2000)"]
+ restartPolicy: Never
+' http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs
+
+++Output
+
+job "example-job" created
+
+++Response Body
+
+{
+ "kind": "Job",
+ "apiVersion": "batch/v1",
+ "metadata": {
+ "name": "example-job",
+ "namespace": "default",
+ "selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
+ "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "resourceVersion": "7479",
+ "creationTimestamp": "2016-11-04T18:45:25Z"
+ },
+ "spec": {
+ "parallelism": 1,
+ "completions": 1,
+ "selector": {
+ "matchLabels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
+ }
+ },
+ "template": {
+ "metadata": {
+ "name": "example-job",
+ "creationTimestamp": null,
+ "labels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "job-name": "example-job"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "pi",
+ "image": "perl",
+ "command": [
+ "perl",
+ "-Mbignum=bpi",
+ "-wle",
+ "print bpi(2000)"
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Never",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ }
+ },
+ "status": {}
+}
+
+create a Job
+POST /apis/batch/v1/namespaces/{namespace}/jobs
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Job |
++ |
Code | +Description | +
---|---|
200 Job |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified Job
+PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}
Parameter | +Description | +
---|---|
name | +name of the Job | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 Job |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified Job
+PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}
Parameter | +Description | +
---|---|
name | +name of the Job | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Job |
++ |
Code | +Description | +
---|---|
200 Job |
+OK | +
+++
kubectl
Command
+$ kubectl delete job example-job
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs/example-job'
+
+++Output
+
+job "example-job" deleted
+
+++Response Body
+
+{
+ "kind": "Status",
+ "apiVersion": "v1",
+ "metadata": {},
+ "status": "Success",
+ "code": 200
+}
+
+delete a Job
+DELETE /apis/batch/v1/namespaces/{namespace}/jobs/{name}
Parameter | +Description | +
---|---|
name | +name of the Job | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of Job
+DELETE /apis/batch/v1/namespaces/{namespace}/jobs
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+$ kubectl get job example-job -o json
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X GET http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs/example-job
+
+++Output
+
+{
+ "kind": "Job",
+ "apiVersion": "batch/v1",
+ "metadata": {
+ "name": "example-job",
+ "namespace": "default",
+ "selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
+ "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "resourceVersion": "7482",
+ "creationTimestamp": "2016-11-04T18:45:25Z"
+ },
+ "spec": {
+ "parallelism": 1,
+ "completions": 1,
+ "selector": {
+ "matchLabels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
+ }
+ },
+ "template": {
+ "metadata": {
+ "name": "example-job",
+ "creationTimestamp": null,
+ "labels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "job-name": "example-job"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "pi",
+ "image": "perl",
+ "command": [
+ "perl",
+ "-Mbignum=bpi",
+ "-wle",
+ "print bpi(2000)"
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Never",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ }
+ },
+ "status": {
+ "startTime": "2016-11-04T18:45:25Z",
+ "active": 1
+ }
+}
+
+++Response Body
+
+{
+ "kind": "Job",
+ "apiVersion": "batch/v1",
+ "metadata": {
+ "name": "example-job",
+ "namespace": "default",
+ "selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
+ "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "resourceVersion": "7482",
+ "creationTimestamp": "2016-11-04T18:45:25Z"
+ },
+ "spec": {
+ "parallelism": 1,
+ "completions": 1,
+ "selector": {
+ "matchLabels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
+ }
+ },
+ "template": {
+ "metadata": {
+ "name": "example-job",
+ "creationTimestamp": null,
+ "labels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "job-name": "example-job"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "pi",
+ "image": "perl",
+ "command": [
+ "perl",
+ "-Mbignum=bpi",
+ "-wle",
+ "print bpi(2000)"
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Never",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ }
+ },
+ "status": {
+ "startTime": "2016-11-04T18:45:25Z",
+ "active": 1
+ }
+}
+
+read the specified Job
+GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}
Parameter | +Description | +
---|---|
name | +name of the Job | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 Job |
+OK | +
+++
kubectl
Command
+$ kubectl get job -o json
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs'
+
+++Output
+
+{
+ "kind": "JobList",
+ "apiVersion": "batch/v1",
+ "metadata": {
+ "selfLink": "/apis/batch/v1/namespaces/default/jobs",
+ "resourceVersion": "7589"
+ },
+ "items": [
+ {
+ "metadata": {
+ "name": "",
+ "namespace": "default",
+ "selfLink": "/apis/batch/v1/namespaces/default/jobs/",
+ "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "resourceVersion": "7482",
+ "creationTimestamp": "2016-11-04T18:45:25Z"
+ },
+ "spec": {
+ "parallelism": 1,
+ "completions": 1,
+ "selector": {
+ "matchLabels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
+ }
+ },
+ "template": {
+ "metadata": {
+ "name": "",
+ "creationTimestamp": null,
+ "labels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "job-name": ""
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "pi",
+ "image": "perl",
+ "command": [
+ "perl",
+ "-Mbignum=bpi",
+ "-wle",
+ "print bpi(2000)"
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Never",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ }
+ },
+ "status": {
+ "startTime": "2016-11-04T18:45:25Z",
+ "active": 1
+ }
+ }
+ ]
+}
+
+++Response Body
+
+{
+ "kind": "JobList",
+ "apiVersion": "batch/v1",
+ "metadata": {
+ "selfLink": "/apis/batch/v1/namespaces/default/jobs",
+ "resourceVersion": "7589"
+ },
+ "items": [
+ {
+ "metadata": {
+ "name": "",
+ "namespace": "default",
+ "selfLink": "/apis/batch/v1/namespaces/default/jobs/",
+ "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "resourceVersion": "7482",
+ "creationTimestamp": "2016-11-04T18:45:25Z"
+ },
+ "spec": {
+ "parallelism": 1,
+ "completions": 1,
+ "selector": {
+ "matchLabels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
+ }
+ },
+ "template": {
+ "metadata": {
+ "name": "",
+ "creationTimestamp": null,
+ "labels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "job-name": ""
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "pi",
+ "image": "perl",
+ "command": [
+ "perl",
+ "-Mbignum=bpi",
+ "-wle",
+ "print bpi(2000)"
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Never",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ }
+ },
+ "status": {
+ "startTime": "2016-11-04T18:45:25Z",
+ "active": 1
+ }
+ }
+ ]
+}
+
+list or watch objects of kind Job
+GET /apis/batch/v1/namespaces/{namespace}/jobs
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 JobList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind Job
+GET /apis/batch/v1/jobs
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 JobList |
+OK | +
+++
kubectl
Command
+$ kubectl get job example-job --watch -o json
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/batch/v1/watch/namespaces/default/jobs/example-job'
+
+++Output
+
+{
+ "type": "ADDED",
+ "object": {
+ "kind": "Job",
+ "apiVersion": "batch/v1",
+ "metadata": {
+ "name": "example-job",
+ "namespace": "default",
+ "selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
+ "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "resourceVersion": "7482",
+ "creationTimestamp": "2016-11-04T18:45:25Z"
+ },
+ "spec": {
+ "parallelism": 1,
+ "completions": 1,
+ "selector": {
+ "matchLabels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
+ }
+ },
+ "template": {
+ "metadata": {
+ "name": "example-job",
+ "creationTimestamp": null,
+ "labels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "job-name": "example-job"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "pi",
+ "image": "perl",
+ "command": [
+ "perl",
+ "-Mbignum=bpi",
+ "-wle",
+ "print bpi(2000)"
+ ],
+ "resources": {
+ },
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Never",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {
+ }
+ }
+ }
+ },
+ "status": {
+ "startTime": "2016-11-04T18:45:25Z",
+ "active": 1
+ }
+ }
+}
+
+++Response Body
+
+{
+ "type": "ADDED",
+ "object": {
+ "kind": "Job",
+ "apiVersion": "batch/v1",
+ "metadata": {
+ "name": "example-job",
+ "namespace": "default",
+ "selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
+ "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "resourceVersion": "7482",
+ "creationTimestamp": "2016-11-04T18:45:25Z"
+ },
+ "spec": {
+ "parallelism": 1,
+ "completions": 1,
+ "selector": {
+ "matchLabels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
+ }
+ },
+ "template": {
+ "metadata": {
+ "name": "example-job",
+ "creationTimestamp": null,
+ "labels": {
+ "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+ "job-name": "example-job"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "pi",
+ "image": "perl",
+ "command": [
+ "perl",
+ "-Mbignum=bpi",
+ "-wle",
+ "print bpi(2000)"
+ ],
+ "resources": {
+ },
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Never",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {
+ }
+ }
+ }
+ },
+ "status": {
+ "startTime": "2016-11-04T18:45:25Z",
+ "active": 1
+ }
+ }
+}
+
+watch changes to an object of kind Job
+GET /apis/batch/v1/watch/namespaces/{namespace}/jobs/{name}
Parameter | +Description | +
---|---|
name | +name of the Job | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Job
+GET /apis/batch/v1/watch/namespaces/{namespace}/jobs
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Job
+GET /apis/batch/v1/watch/jobs
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update status of the specified Job
+PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Job | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 Job |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read status of the specified Job
+GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Job | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 Job |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified Job
+PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Job | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Job |
++ |
Code | +Description | +
---|---|
200 Job |
+OK | +
++Pod Config to print "Hello World".
+
+apiVersion: v1
+kind: Pod
+metadata:
+ name: pod-example
+spec:
+ containers:
+ - image: ubuntu:trusty
+ command: ["echo"]
+ args: ["Hello World"]
+
+++Pod Config to print "Hello World".
+
+apiVersion: v1
+kind: Pod
+metadata:
+ name: pod-example
+spec:
+ containers:
+ - image: ubuntu:trusty
+ command: ["echo"]
+ args: ["Hello World"]
+
+Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +Pod | +
Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec PodSpec |
+Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
status PodStatus |
+Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
Field | +Description | +
---|---|
activeDeadlineSeconds integer |
+Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. | +
affinity Affinity |
+If specified, the pod's scheduling constraints | +
automountServiceAccountToken boolean |
+AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. | +
containers Container array patch type: merge patch merge key: name |
+List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. | +
dnsPolicy string |
+Set DNS policy for containers within the pod. One of 'ClusterFirstWithHostNet', 'ClusterFirst' or 'Default'. Defaults to "ClusterFirst". To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. | +
hostAliases HostAlias array patch type: merge patch merge key: ip |
+HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods. | +
hostIPC boolean |
+Use the host's ipc namespace. Optional: Default to false. | +
hostNetwork boolean |
+Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false. | +
hostPID boolean |
+Use the host's pid namespace. Optional: Default to false. | +
hostname string |
+Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value. | +
imagePullSecrets LocalObjectReference array patch type: merge patch merge key: name |
+ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod | +
initContainers Container array patch type: merge patch merge key: name |
+List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, or Liveness probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ | +
nodeName string |
+NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements. | +
nodeSelector object |
+NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ | +
priority integer |
+The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. | +
priorityClassName string |
+If specified, indicates the pod's priority. "SYSTEM" is a special keyword which indicates the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. | +
restartPolicy string |
+Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy | +
schedulerName string |
+If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler. | +
securityContext PodSecurityContext |
+SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. | +
serviceAccount string |
+DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. | +
serviceAccountName string |
+ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ | +
subdomain string |
+If specified, the fully qualified Pod hostname will be " |
+
terminationGracePeriodSeconds integer |
+Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. | +
tolerations Toleration array |
+If specified, the pod's tolerations. | +
volumes Volume array patch type: merge,retainKeys patch merge key: name |
+List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes | +
Field | +Description | +
---|---|
conditions PodCondition array patch type: merge patch merge key: type |
+Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions | +
containerStatuses ContainerStatus array |
+The list has one entry per container in the manifest. Each entry is currently the output of docker inspect . More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status |
+
hostIP string |
+IP address of the host to which the pod is assigned. Empty if not yet scheduled. | +
initContainerStatuses ContainerStatus array |
+The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status | +
message string |
+A human readable message indicating details about why the pod is in this condition. | +
phase string |
+Current condition of the pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase | +
podIP string |
+IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated. | +
qosClass string |
+The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://github.com/kubernetes/kubernetes/blob/master/docs/design/resource-qos.md | +
reason string |
+A brief CamelCase message indicating details about why the pod is in this state. e.g. 'Evicted' | +
startTime Time |
+RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items Pod array |
+List of pods. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a Pod
+POST /api/v1/namespaces/{namespace}/pods
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Pod |
++ |
Code | +Description | +
---|---|
200 Pod |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified Pod
+PATCH /api/v1/namespaces/{namespace}/pods/{name}
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 Pod |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified Pod
+PUT /api/v1/namespaces/{namespace}/pods/{name}
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Pod |
++ |
Code | +Description | +
---|---|
200 Pod |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a Pod
+DELETE /api/v1/namespaces/{namespace}/pods/{name}
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of Pod
+DELETE /api/v1/namespaces/{namespace}/pods
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified Pod
+GET /api/v1/namespaces/{namespace}/pods/{name}
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 Pod |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind Pod
+GET /api/v1/namespaces/{namespace}/pods
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 PodList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind Pod
+GET /api/v1/pods
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 PodList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind Pod
+GET /api/v1/watch/namespaces/{namespace}/pods/{name}
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Pod
+GET /api/v1/watch/namespaces/{namespace}/pods
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Pod
+GET /api/v1/watch/pods
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update status of the specified Pod
+PATCH /api/v1/namespaces/{namespace}/pods/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 Pod |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read status of the specified Pod
+GET /api/v1/namespaces/{namespace}/pods/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 Pod |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified Pod
+PUT /api/v1/namespaces/{namespace}/pods/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Pod |
++ |
Code | +Description | +
---|---|
200 Pod |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect POST requests to portforward of Pod
+POST /api/v1/namespaces/{namespace}/pods/{name}/portforward
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
ports | +List of ports to forward Required when using WebSockets | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect POST requests to proxy of Pod
+POST /api/v1/namespaces/{namespace}/pods/{name}/proxy
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
path | +Path is the URL path to use for the current proxy request to pod. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect POST requests to proxy of Pod
+POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
path | +path to the resource | +
Parameter | +Description | +
---|---|
path | +Path is the URL path to use for the current proxy request to pod. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+proxy POST requests to Pod
+POST /api/v1/proxy/namespaces/{namespace}/pods/{name}
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+proxy POST requests to Pod
+POST /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
path | +path to the resource | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect DELETE requests to proxy of Pod
+DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
path | +Path is the URL path to use for the current proxy request to pod. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect DELETE requests to proxy of Pod
+DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
path | +path to the resource | +
Parameter | +Description | +
---|---|
path | +Path is the URL path to use for the current proxy request to pod. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+proxy DELETE requests to Pod
+DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+proxy DELETE requests to Pod
+DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
path | +path to the resource | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect GET requests to portforward of Pod
+GET /api/v1/namespaces/{namespace}/pods/{name}/portforward
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
ports | +List of ports to forward Required when using WebSockets | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect GET requests to proxy of Pod
+GET /api/v1/namespaces/{namespace}/pods/{name}/proxy
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
path | +Path is the URL path to use for the current proxy request to pod. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect GET requests to proxy of Pod
+GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
path | +path to the resource | +
Parameter | +Description | +
---|---|
path | +Path is the URL path to use for the current proxy request to pod. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+proxy GET requests to Pod
+GET /api/v1/proxy/namespaces/{namespace}/pods/{name}
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+proxy GET requests to Pod
+GET /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
path | +path to the resource | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect HEAD requests to proxy of Pod
+HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
path | +Path is the URL path to use for the current proxy request to pod. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect HEAD requests to proxy of Pod
+HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
path | +path to the resource | +
Parameter | +Description | +
---|---|
path | +Path is the URL path to use for the current proxy request to pod. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect PUT requests to proxy of Pod
+PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
path | +Path is the URL path to use for the current proxy request to pod. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect PUT requests to proxy of Pod
+PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
path | +path to the resource | +
Parameter | +Description | +
---|---|
path | +Path is the URL path to use for the current proxy request to pod. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+proxy PUT requests to Pod
+PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+proxy PUT requests to Pod
+PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
path | +path to the resource | +
Code | +Description | +
---|---|
200 string |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read log of the specified Pod
+GET /api/v1/namespaces/{namespace}/pods/{name}/log
Parameter | +Description | +
---|---|
name | +name of the Pod | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
container | +The container for which to stream logs. Defaults to only container if there is one container in the pod. | +
follow | +Follow the log stream of the pod. Defaults to false. | +
limitBytes | +If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. | +
pretty | +If 'true', then the output is pretty printed. | +
previous | +Return previous terminated container logs. Defaults to false. | +
sinceSeconds | +A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. | +
tailLines | +If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime | +
timestamps | +If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. | +
Code | +Description | +
---|---|
200 string |
+OK | +
++ReplicaSet Config to run 3 nginx instances.
+
+apiVersion: extensions/v1beta1
+kind: ReplicaSet
+metadata:
+ # Unique key of the ReplicaSet instance
+ name: replicaset-example
+spec:
+ # 3 Pods should exist at all times.
+ replicas: 3
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ # Run the nginx image
+ - name: nginx
+ image: nginx:1.10
+
+++ReplicaSet Config to run 3 nginx instances.
+
+apiVersion: extensions/v1beta1
+kind: ReplicaSet
+metadata:
+ # Unique key of the ReplicaSet instance
+ name: replicaset-example
+spec:
+ # 3 Pods should exist at all times.
+ replicas: 3
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ # Run the nginx image
+ - name: nginx
+ image: nginx:1.10
+
+Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +ReplicaSet | +
DEPRECATED - This group version of ReplicaSet is deprecated by apps/v1beta2/ReplicaSet. See the release notes for more information. ReplicaSet represents the configuration of a ReplicaSet.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec ReplicaSetSpec |
+Spec defines the specification of the desired behavior of the ReplicaSet. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
status ReplicaSetStatus |
+Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
Field | +Description | +
---|---|
minReadySeconds integer |
+Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) | +
replicas integer |
+Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller | +
selector LabelSelector |
+Selector is a label query over pods that should match the replica count. If the selector is empty, it is defaulted to the labels present on the pod template. Label keys and values that must match in order to be controlled by this replica set. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | +
template PodTemplateSpec |
+Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template | +
Field | +Description | +
---|---|
availableReplicas integer |
+The number of available replicas (ready for at least minReadySeconds) for this replica set. | +
conditions ReplicaSetCondition array patch type: merge patch merge key: type |
+Represents the latest available observations of a replica set's current state. | +
fullyLabeledReplicas integer |
+The number of pods that have labels matching the labels of the pod template of the replicaset. | +
observedGeneration integer |
+ObservedGeneration reflects the generation of the most recently observed ReplicaSet. | +
readyReplicas integer |
+The number of ready replicas for this replica set. | +
replicas integer |
+Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items ReplicaSet array |
+List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a ReplicaSet
+POST /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ReplicaSet |
++ |
Code | +Description | +
---|---|
200 ReplicaSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified ReplicaSet
+PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
Parameter | +Description | +
---|---|
name | +name of the ReplicaSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 ReplicaSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified ReplicaSet
+PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
Parameter | +Description | +
---|---|
name | +name of the ReplicaSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ReplicaSet |
++ |
Code | +Description | +
---|---|
200 ReplicaSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a ReplicaSet
+DELETE /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
Parameter | +Description | +
---|---|
name | +name of the ReplicaSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of ReplicaSet
+DELETE /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified ReplicaSet
+GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
Parameter | +Description | +
---|---|
name | +name of the ReplicaSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 ReplicaSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind ReplicaSet
+GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ReplicaSetList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind ReplicaSet
+GET /apis/extensions/v1beta1/replicasets
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ReplicaSetList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind ReplicaSet
+GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets/{name}
Parameter | +Description | +
---|---|
name | +name of the ReplicaSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of ReplicaSet
+GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of ReplicaSet
+GET /apis/extensions/v1beta1/watch/replicasets
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update status of the specified ReplicaSet
+PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status
Parameter | +Description | +
---|---|
name | +name of the ReplicaSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 ReplicaSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read status of the specified ReplicaSet
+GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status
Parameter | +Description | +
---|---|
name | +name of the ReplicaSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 ReplicaSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified ReplicaSet
+PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status
Parameter | +Description | +
---|---|
name | +name of the ReplicaSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ReplicaSet |
++ |
Code | +Description | +
---|---|
200 ReplicaSet |
+OK | +
++ReplicationController Config to run 3 nginx instances.
+
+apiVersion: v1
+kind: ReplicationController
+metadata:
+ # Unique key of the ReplicationController instance
+ name: replicationcontroller-example
+spec:
+ # 3 Pods should exist at all times.
+ replicas: 3
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ # Run the nginx image
+ - name: nginx
+ image: nginx:1.10
+
+++ReplicationController Config to run 3 nginx instances.
+
+apiVersion: v1
+kind: ReplicationController
+metadata:
+ # Unique key of the ReplicationController instance
+ name: replicationcontroller-example
+spec:
+ # 3 Pods should exist at all times.
+ replicas: 3
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ # Run the nginx image
+ - name: nginx
+ image: nginx:1.10
+
+Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ReplicationController | +
ReplicationController represents the configuration of a replication controller.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec ReplicationControllerSpec |
+Spec defines the specification of the desired behavior of the replication controller. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
status ReplicationControllerStatus |
+Status is the most recently observed status of the replication controller. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
Field | +Description | +
---|---|
minReadySeconds integer |
+Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) | +
replicas integer |
+Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller | +
selector object |
+Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | +
template PodTemplateSpec |
+Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template | +
Field | +Description | +
---|---|
availableReplicas integer |
+The number of available replicas (ready for at least minReadySeconds) for this replication controller. | +
conditions ReplicationControllerCondition array patch type: merge patch merge key: type |
+Represents the latest available observations of a replication controller's current state. | +
fullyLabeledReplicas integer |
+The number of pods that have labels matching the labels of the pod template of the replication controller. | +
observedGeneration integer |
+ObservedGeneration reflects the generation of the most recently observed replication controller. | +
readyReplicas integer |
+The number of ready replicas for this replication controller. | +
replicas integer |
+Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items ReplicationController array |
+List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a ReplicationController
+POST /api/v1/namespaces/{namespace}/replicationcontrollers
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ReplicationController |
++ |
Code | +Description | +
---|---|
200 ReplicationController |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified ReplicationController
+PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
Parameter | +Description | +
---|---|
name | +name of the ReplicationController | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 ReplicationController |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified ReplicationController
+PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
Parameter | +Description | +
---|---|
name | +name of the ReplicationController | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ReplicationController |
++ |
Code | +Description | +
---|---|
200 ReplicationController |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a ReplicationController
+DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
Parameter | +Description | +
---|---|
name | +name of the ReplicationController | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of ReplicationController
+DELETE /api/v1/namespaces/{namespace}/replicationcontrollers
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified ReplicationController
+GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
Parameter | +Description | +
---|---|
name | +name of the ReplicationController | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 ReplicationController |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind ReplicationController
+GET /api/v1/namespaces/{namespace}/replicationcontrollers
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ReplicationControllerList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind ReplicationController
+GET /api/v1/replicationcontrollers
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ReplicationControllerList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind ReplicationController
+GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name}
Parameter | +Description | +
---|---|
name | +name of the ReplicationController | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of ReplicationController
+GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of ReplicationController
+GET /api/v1/watch/replicationcontrollers
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update status of the specified ReplicationController
+PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
Parameter | +Description | +
---|---|
name | +name of the ReplicationController | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 ReplicationController |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read status of the specified ReplicationController
+GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
Parameter | +Description | +
---|---|
name | +name of the ReplicationController | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 ReplicationController |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified ReplicationController
+PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
Parameter | +Description | +
---|---|
name | +name of the ReplicationController | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ReplicationController |
++ |
Code | +Description | +
---|---|
200 ReplicationController |
+OK | +
Group | +Version | +Kind | +
---|---|---|
apps | +v1beta1 | +StatefulSet | +
DEPRECATED - This group version of StatefulSet is deprecated by apps/v1beta2/StatefulSet. See the release notes for more information. StatefulSet represents a set of pods with consistent identities. Identities are defined as:
+Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
++ |
spec StatefulSetSpec |
+Spec defines the desired identities of pods in this set. | +
status StatefulSetStatus |
+Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time. | +
Field | +Description | +
---|---|
podManagementPolicy string |
+podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is OrderedReady , where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once. |
+
replicas integer |
+replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1. | +
revisionHistoryLimit integer |
+revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10. | +
selector LabelSelector |
+selector is a label query over pods that should match the replica count. If empty, defaulted to labels on the pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | +
serviceName string |
+serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller. | +
template PodTemplateSpec |
+template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet. | +
updateStrategy StatefulSetUpdateStrategy |
+updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. | +
volumeClaimTemplates PersistentVolumeClaim array |
+volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name. | +
Field | +Description | +
---|---|
collisionCount integer |
+collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision. | +
currentReplicas integer |
+currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision. | +
currentRevision string |
+currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas). | +
observedGeneration integer |
+observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server. | +
readyReplicas integer |
+readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition. | +
replicas integer |
+replicas is the number of Pods created by the StatefulSet controller. | +
updateRevision string |
+updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas) | +
updatedReplicas integer |
+updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items StatefulSet array |
++ |
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
++ |
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a StatefulSet
+POST /apis/apps/v1beta1/namespaces/{namespace}/statefulsets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body StatefulSet |
++ |
Code | +Description | +
---|---|
200 StatefulSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified StatefulSet
+PATCH /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}
Parameter | +Description | +
---|---|
name | +name of the StatefulSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 StatefulSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified StatefulSet
+PUT /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}
Parameter | +Description | +
---|---|
name | +name of the StatefulSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body StatefulSet |
++ |
Code | +Description | +
---|---|
200 StatefulSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a StatefulSet
+DELETE /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}
Parameter | +Description | +
---|---|
name | +name of the StatefulSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of StatefulSet
+DELETE /apis/apps/v1beta1/namespaces/{namespace}/statefulsets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified StatefulSet
+GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}
Parameter | +Description | +
---|---|
name | +name of the StatefulSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 StatefulSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind StatefulSet
+GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 StatefulSetList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind StatefulSet
+GET /apis/apps/v1beta1/statefulsets
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 StatefulSetList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind StatefulSet
+GET /apis/apps/v1beta1/watch/namespaces/{namespace}/statefulsets/{name}
Parameter | +Description | +
---|---|
name | +name of the StatefulSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of StatefulSet
+GET /apis/apps/v1beta1/watch/namespaces/{namespace}/statefulsets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of StatefulSet
+GET /apis/apps/v1beta1/watch/statefulsets
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update status of the specified StatefulSet
+PATCH /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status
Parameter | +Description | +
---|---|
name | +name of the StatefulSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 StatefulSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read status of the specified StatefulSet
+GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status
Parameter | +Description | +
---|---|
name | +name of the StatefulSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 StatefulSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified StatefulSet
+PUT /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status
Parameter | +Description | +
---|---|
name | +name of the StatefulSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body StatefulSet |
++ |
Code | +Description | +
---|---|
200 StatefulSet |
+OK | +
Discovery and Load Balancing resources are responsible for stitching your workloads together into an accessible Loadbalanced Service. By default,
+Workloads are only accessible within the cluster, and they must be exposed externally using a either
+a LoadBalancer or NodePort Service. For development, internally accessible
+Workloads can be accessed via proxy through the api master using the kubectl proxy
command.
Common resource types:
+Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +Endpoints | +
Endpoints is a collection of endpoints that implement the actual service. Example: + Name: "mysvc", + Subsets: [ + { + Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], + Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] + }, + { + Addresses: [{"ip": "10.10.3.3"}], + Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] + }, + ]
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
subsets EndpointSubset array |
+The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items Endpoints array |
+List of endpoints. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create Endpoints
+POST /api/v1/namespaces/{namespace}/endpoints
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Endpoints |
++ |
Code | +Description | +
---|---|
200 Endpoints |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified Endpoints
+PATCH /api/v1/namespaces/{namespace}/endpoints/{name}
Parameter | +Description | +
---|---|
name | +name of the Endpoints | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 Endpoints |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified Endpoints
+PUT /api/v1/namespaces/{namespace}/endpoints/{name}
Parameter | +Description | +
---|---|
name | +name of the Endpoints | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Endpoints |
++ |
Code | +Description | +
---|---|
200 Endpoints |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete Endpoints
+DELETE /api/v1/namespaces/{namespace}/endpoints/{name}
Parameter | +Description | +
---|---|
name | +name of the Endpoints | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of Endpoints
+DELETE /api/v1/namespaces/{namespace}/endpoints
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified Endpoints
+GET /api/v1/namespaces/{namespace}/endpoints/{name}
Parameter | +Description | +
---|---|
name | +name of the Endpoints | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 Endpoints |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind Endpoints
+GET /api/v1/namespaces/{namespace}/endpoints
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 EndpointsList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind Endpoints
+GET /api/v1/endpoints
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 EndpointsList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind Endpoints
+GET /api/v1/watch/namespaces/{namespace}/endpoints/{name}
Parameter | +Description | +
---|---|
name | +name of the Endpoints | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Endpoints
+GET /api/v1/watch/namespaces/{namespace}/endpoints
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Endpoints
+GET /api/v1/watch/endpoints
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +Ingress | +
Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec IngressSpec |
+Spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
status IngressStatus |
+Status is the current state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
Field | +Description | +
---|---|
backend IngressBackend |
+A default backend capable of servicing requests that don't match any rule. At least one of 'backend' or 'rules' must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default. | +
rules IngressRule array |
+A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend. | +
tls IngressTLS array |
+TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI. | +
Field | +Description | +
---|---|
loadBalancer LoadBalancerStatus |
+LoadBalancer contains the current status of the load-balancer. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items Ingress array |
+Items is the list of Ingress. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create an Ingress
+POST /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Ingress |
++ |
Code | +Description | +
---|---|
200 Ingress |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified Ingress
+PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
Parameter | +Description | +
---|---|
name | +name of the Ingress | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 Ingress |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified Ingress
+PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
Parameter | +Description | +
---|---|
name | +name of the Ingress | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Ingress |
++ |
Code | +Description | +
---|---|
200 Ingress |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete an Ingress
+DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
Parameter | +Description | +
---|---|
name | +name of the Ingress | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of Ingress
+DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified Ingress
+GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
Parameter | +Description | +
---|---|
name | +name of the Ingress | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 Ingress |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind Ingress
+GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 IngressList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind Ingress
+GET /apis/extensions/v1beta1/ingresses
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 IngressList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind Ingress
+GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses/{name}
Parameter | +Description | +
---|---|
name | +name of the Ingress | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Ingress
+GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Ingress
+GET /apis/extensions/v1beta1/watch/ingresses
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update status of the specified Ingress
+PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Ingress | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 Ingress |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read status of the specified Ingress
+GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Ingress | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 Ingress |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified Ingress
+PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Ingress | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Ingress |
++ |
Code | +Description | +
---|---|
200 Ingress |
+OK | +
++Service Config to load balance traffic across all Pods with the app=nginx label. Receives on and sends to port 80. Exposes an externally accessible endpoint.
+
+kind: Service
+apiVersion: v1
+metadata:
+ # Unique key of the Service instance
+ name: service-example
+spec:
+ ports:
+ # Accept traffic sent to port 80
+ - name: http
+ port: 80
+ targetPort: 80
+ selector:
+ # Loadbalance traffic across Pods matching
+ # this label selector
+ app: nginx
+ # Create an HA proxy in the cloud provider
+ # with an External IP address - *Only supported
+ # by some cloud providers*
+ type: LoadBalancer
+
+++Service Config to load balance traffic across all Pods with the app=nginx label. Receives on and sends to port 80. Exposes an externally accessible endpoint.
+
+kind: Service
+apiVersion: v1
+metadata:
+ # Unique key of the Service instance
+ name: service-example
+spec:
+ ports:
+ # Accept traffic sent to port 80
+ - name: http
+ port: 80
+ targetPort: 80
+ selector:
+ # Loadbalance traffic across Pods matching
+ # this label selector
+ app: nginx
+ # Create an HA proxy in the cloud provider
+ # with an External IP address - *Only supported
+ # by some cloud providers*
+ type: LoadBalancer
+
+Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +Service | +
Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec ServiceSpec |
+Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
status ServiceStatus |
+Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
Field | +Description | +
---|---|
clusterIP string |
+clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies | +
externalIPs string array |
+externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. | +
externalName string |
+externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid DNS name and requires Type to be ExternalName. | +
externalTrafficPolicy string |
+externalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading. | +
healthCheckNodePort integer |
+healthCheckNodePort specifies the healthcheck nodePort for the service. If not specified, HealthCheckNodePort is created by the service api backend with the allocated nodePort. Will use user-specified nodePort value if specified by the client. Only effects when Type is set to LoadBalancer and ExternalTrafficPolicy is set to Local. | +
loadBalancerIP string |
+Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature. | +
loadBalancerSourceRanges string array |
+If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/ | +
ports ServicePort array patch type: merge patch merge key: port |
+The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies | +
publishNotReadyAddresses boolean |
+publishNotReadyAddresses, when set to true, indicates that DNS implementations must publish the notReadyAddresses of subsets for the Endpoints associated with the Service. The default value is false. The primary use case for setting this field is to use a StatefulSet's Headless Service to propagate SRV records for its Pods without respect to their readiness for purpose of peer discovery. This field will replace the service.alpha.kubernetes.io/tolerate-unready-endpoints when that annotation is deprecated and all clients have been converted to use this field. | +
selector object |
+Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/ | +
sessionAffinity string |
+Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies | +
sessionAffinityConfig SessionAffinityConfig |
+sessionAffinityConfig contains the configurations of session affinity. | +
type string |
+type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName" maps to the specified externalName. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services---service-types | +
Field | +Description | +
---|---|
loadBalancer LoadBalancerStatus |
+LoadBalancer contains the current status of the load-balancer, if one is present. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items Service array |
+List of services | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
See supported operations below...
++++
kubectl
Command
+$ echo 'kind: Service
+apiVersion: v1
+metadata:
+ name: service-example
+spec:
+ ports:
+ - name: http
+ port: 80
+ targetPort: 80
+ selector:
+ app: nginx
+ type: LoadBalancer
+' | kubectl create -f -
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+kind: Service
+apiVersion: v1
+metadata:
+ name: service-example
+spec:
+ ports:
+ - name: http
+ port: 80
+ targetPort: 80
+ selector:
+ app: nginx
+ type: LoadBalancer
+' http://127.0.0.1:8001/api/v1/namespaces/default/services
+
+++Output
+
+service "service-example" created
+
+++Response Body
+
+{
+ "kind": "Service",
+ "apiVersion": "v1",
+ "metadata": {
+ "name": "service-example",
+ "namespace": "default",
+ "selfLink": "/api/v1/namespaces/default/services/service-example",
+ "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
+ "resourceVersion": "2205767",
+ "creationTimestamp": "2016-10-28T17:04:24Z"
+ },
+ "spec": {
+ "ports": [
+ {
+ "name": "http",
+ "protocol": "TCP",
+ "port": 80,
+ "targetPort": 80,
+ "nodePort": 32417
+ }
+ ],
+ "selector": {
+ "app": "nginx"
+ },
+ "clusterIP": "10.183.250.161",
+ "type": "LoadBalancer",
+ "sessionAffinity": "None"
+ },
+ "status": {
+ "loadBalancer": {}
+ }
+}
+
+create a Service
+POST /api/v1/namespaces/{namespace}/services
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Service |
++ |
Code | +Description | +
---|---|
200 Service |
+OK | +
+++
kubectl
Command
+$ kubectl patch service -p \
+ '{"spec":{"ports":[{"name":"http","port":80,"targetPort":8080}]}}'
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X PATCH -H 'Content-Type: application/strategic-merge-patch+json' --data '
+{"spec":{"ports":[{"name":"http","port":80,"targetPort":8080}]}}' \
+ 'http://127.0.0.1:8001/api/v1/namespaces/default/services/'
+
+++Output
+
+"" patched
+
+++Response Body
+
+{
+ "kind": "Service",
+ "apiVersion": "v1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/api/v1/namespaces/default/services/deployment-example",
+ "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
+ "resourceVersion": "2205995",
+ "creationTimestamp": "2016-10-28T17:04:24Z"
+ },
+ "spec": {
+ "ports": [
+ {
+ "name": "http",
+ "protocol": "TCP",
+ "port": 80,
+ "targetPort": 8080,
+ "nodePort": 32417
+ }
+ ],
+ "selector": {
+ "app": "nginx"
+ },
+ "clusterIP": "10.183.250.161",
+ "type": "LoadBalancer",
+ "sessionAffinity": "None"
+ },
+ "status": {
+ "loadBalancer": {
+ "ingress": [
+ {
+ "ip": "104.198.186.106"
+ }
+ ]
+ }
+ }
+}
+
+partially update the specified Service
+PATCH /api/v1/namespaces/{namespace}/services/{name}
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 Service |
+OK | +
+++
kubectl
Command
+$ echo 'apiVersion: v1
+kind: Service
+metadata:
+ name: deployment-example
+ resourceVersion: "2205995"
+spec:
+ clusterIP: 10.183.250.161
+ ports:
+ - name: http
+ nodePort: 32417
+ port: 80
+ protocol: TCP
+ targetPort: 8080
+ selector:
+ app: nginx
+ sessionAffinity: None
+ type: LoadBalancer
+' | kubectl replace -f -
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X PUT -H 'Content-Type: application/yaml' --data '
+apiVersion: v1
+kind: Service
+metadata:
+ name: deployment-example
+ resourceVersion: "2205995"
+spec:
+ clusterIP: 10.183.250.161
+ ports:
+ - name: http
+ nodePort: 32417
+ port: 80
+ protocol: TCP
+ targetPort: 8080
+ selector:
+ app: nginx
+ sessionAffinity: None
+ type: LoadBalancer
+' http://127.0.0.1:8001/api/v1/namespaces/default/services/deployment-example
+
+++Output
+
+service "deployment-example" replaced
+
+++Response Body
+
+{
+ "kind": "Service",
+ "apiVersion": "v1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/api/v1/namespaces/default/services/deployment-example",
+ "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
+ "resourceVersion": "2208672",
+ "creationTimestamp": "2016-10-28T17:04:24Z"
+ },
+ "spec": {
+ "ports": [
+ {
+ "name": "http",
+ "protocol": "TCP",
+ "port": 80,
+ "targetPort": 8080,
+ "nodePort": 32417
+ }
+ ],
+ "selector": {
+ "app": "nginx"
+ },
+ "clusterIP": "10.183.250.161",
+ "type": "LoadBalancer",
+ "sessionAffinity": "None"
+ },
+ "status": {
+ "loadBalancer": {
+ "ingress": [
+ {
+ "ip": "104.198.186.106"
+ }
+ ]
+ }
+ }
+}
+
+replace the specified Service
+PUT /api/v1/namespaces/{namespace}/services/{name}
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Service |
++ |
Code | +Description | +
---|---|
200 Service |
+OK | +
+++
kubectl
Command
+$ kubectl delete service deployment-example
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/api/v1/namespaces/default/services/deployment-example'
+
+++Output
+
+service "deployment-example" deleted
+
+++Response Body
+
+{
+ "kind": "Status",
+ "apiVersion": "v1",
+ "metadata": {},
+ "status": "Success",
+ "code": 200
+}
+
+delete a Service
+DELETE /api/v1/namespaces/{namespace}/services/{name}
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+$ kubectl get service deployment-example -o json
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X GET http://127.0.0.1:8001/api/v1/namespaces/default/services/deployment-example
+
+++Output
+
+{
+ "kind": "Service",
+ "apiVersion": "v1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/api/v1/namespaces/default/services/deployment-example",
+ "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
+ "resourceVersion": "2205995",
+ "creationTimestamp": "2016-10-28T17:04:24Z"
+ },
+ "spec": {
+ "ports": [
+ {
+ "name": "http",
+ "protocol": "TCP",
+ "port": 80,
+ "targetPort": 8080,
+ "nodePort": 32417
+ }
+ ],
+ "selector": {
+ "app": "nginx"
+ },
+ "clusterIP": "10.183.250.161",
+ "type": "LoadBalancer",
+ "sessionAffinity": "None"
+ },
+ "status": {
+ "loadBalancer": {
+ "ingress": [
+ {
+ "ip": "104.198.186.106"
+ }
+ ]
+ }
+ }
+}
+
+++Response Body
+
+{
+ "kind": "Service",
+ "apiVersion": "v1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/api/v1/namespaces/default/services/deployment-example",
+ "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
+ "resourceVersion": "2205995",
+ "creationTimestamp": "2016-10-28T17:04:24Z"
+ },
+ "spec": {
+ "ports": [
+ {
+ "name": "http",
+ "protocol": "TCP",
+ "port": 80,
+ "targetPort": 8080,
+ "nodePort": 32417
+ }
+ ],
+ "selector": {
+ "app": "nginx"
+ },
+ "clusterIP": "10.183.250.161",
+ "type": "LoadBalancer",
+ "sessionAffinity": "None"
+ },
+ "status": {
+ "loadBalancer": {
+ "ingress": [
+ {
+ "ip": "104.198.186.106"
+ }
+ ]
+ }
+ }
+}
+
+read the specified Service
+GET /api/v1/namespaces/{namespace}/services/{name}
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 Service |
+OK | +
+++
kubectl
Command
+$ kubectl get service -o json
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/api/v1/namespaces/default/services'
+
+++Output
+
+
+++Response Body
+
+
+list or watch objects of kind Service
+GET /api/v1/namespaces/{namespace}/services
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ServiceList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind Service
+GET /api/v1/services
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ServiceList |
+OK | +
+++
kubectl
Command
+$ kubectl get service deployment-example --watch -o json
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/api/v1/watch/namespaces/default/services/deployment-example'
+
+++Output
+
+{
+ "type": "ADDED",
+ "object": {
+ "kind": "Service",
+ "apiVersion": "v1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/api/v1/namespaces/default/services/deployment-example",
+ "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
+ "resourceVersion": "2205995",
+ "creationTimestamp": "2016-10-28T17:04:24Z"
+ },
+ "spec": {
+ "ports": [
+ {
+ "name": "http",
+ "protocol": "TCP",
+ "port": 80,
+ "targetPort": 8080,
+ "nodePort": 32417
+ }
+ ],
+ "selector": {
+ "app": "nginx"
+ },
+ "clusterIP": "10.183.250.161",
+ "type": "LoadBalancer",
+ "sessionAffinity": "None"
+ },
+ "status": {
+ "loadBalancer": {
+ "ingress": [
+ {
+ "ip": "104.198.186.106"
+ }
+ ]
+ }
+ }
+ }
+}
+
+++Response Body
+
+{
+ "type": "ADDED",
+ "object": {
+ "kind": "Service",
+ "apiVersion": "v1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/api/v1/namespaces/default/services/deployment-example",
+ "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
+ "resourceVersion": "2205995",
+ "creationTimestamp": "2016-10-28T17:04:24Z"
+ },
+ "spec": {
+ "ports": [
+ {
+ "name": "http",
+ "protocol": "TCP",
+ "port": 80,
+ "targetPort": 8080,
+ "nodePort": 32417
+ }
+ ],
+ "selector": {
+ "app": "nginx"
+ },
+ "clusterIP": "10.183.250.161",
+ "type": "LoadBalancer",
+ "sessionAffinity": "None"
+ },
+ "status": {
+ "loadBalancer": {
+ "ingress": [
+ {
+ "ip": "104.198.186.106"
+ }
+ ]
+ }
+ }
+ }
+}
+
+watch changes to an object of kind Service
+GET /api/v1/watch/namespaces/{namespace}/services/{name}
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Service
+GET /api/v1/watch/namespaces/{namespace}/services
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Service
+GET /api/v1/watch/services
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update status of the specified Service
+PATCH /api/v1/namespaces/{namespace}/services/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 Service |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read status of the specified Service
+GET /api/v1/namespaces/{namespace}/services/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 Service |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified Service
+PUT /api/v1/namespaces/{namespace}/services/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Service |
++ |
Code | +Description | +
---|---|
200 Service |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect POST requests to proxy of Service
+POST /api/v1/namespaces/{namespace}/services/{name}/proxy
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
path | +Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect POST requests to proxy of Service
+POST /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
path | +path to the resource | +
Parameter | +Description | +
---|---|
path | +Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+proxy POST requests to Service
+POST /api/v1/proxy/namespaces/{namespace}/services/{name}
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+proxy POST requests to Service
+POST /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
path | +path to the resource | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect DELETE requests to proxy of Service
+DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
path | +Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect DELETE requests to proxy of Service
+DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
path | +path to the resource | +
Parameter | +Description | +
---|---|
path | +Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+proxy DELETE requests to Service
+DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+proxy DELETE requests to Service
+DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
path | +path to the resource | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect GET requests to proxy of Service
+GET /api/v1/namespaces/{namespace}/services/{name}/proxy
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
path | +Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect GET requests to proxy of Service
+GET /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
path | +path to the resource | +
Parameter | +Description | +
---|---|
path | +Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+proxy GET requests to Service
+GET /api/v1/proxy/namespaces/{namespace}/services/{name}
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+proxy GET requests to Service
+GET /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
path | +path to the resource | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect HEAD requests to proxy of Service
+HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
path | +Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect HEAD requests to proxy of Service
+HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
path | +path to the resource | +
Parameter | +Description | +
---|---|
path | +Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect PUT requests to proxy of Service
+PUT /api/v1/namespaces/{namespace}/services/{name}/proxy
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
path | +Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect PUT requests to proxy of Service
+PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
path | +path to the resource | +
Parameter | +Description | +
---|---|
path | +Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+proxy PUT requests to Service
+PUT /api/v1/proxy/namespaces/{namespace}/services/{name}
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+proxy PUT requests to Service
+PUT /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
Parameter | +Description | +
---|---|
name | +name of the Service | +
namespace | +object name and auth scope, such as for teams and projects | +
path | +path to the resource | +
Code | +Description | +
---|---|
200 string |
+OK | +
Config and Storage resources are responsible for injecting data into your applications and persisting data externally to your container.
+Common resource types:
+Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ConfigMap | +
ConfigMap holds configuration data for pods to consume.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
data object |
+Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items ConfigMap array |
+Items is the list of ConfigMaps. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a ConfigMap
+POST /api/v1/namespaces/{namespace}/configmaps
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ConfigMap |
++ |
Code | +Description | +
---|---|
200 ConfigMap |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified ConfigMap
+PATCH /api/v1/namespaces/{namespace}/configmaps/{name}
Parameter | +Description | +
---|---|
name | +name of the ConfigMap | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 ConfigMap |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified ConfigMap
+PUT /api/v1/namespaces/{namespace}/configmaps/{name}
Parameter | +Description | +
---|---|
name | +name of the ConfigMap | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ConfigMap |
++ |
Code | +Description | +
---|---|
200 ConfigMap |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a ConfigMap
+DELETE /api/v1/namespaces/{namespace}/configmaps/{name}
Parameter | +Description | +
---|---|
name | +name of the ConfigMap | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of ConfigMap
+DELETE /api/v1/namespaces/{namespace}/configmaps
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified ConfigMap
+GET /api/v1/namespaces/{namespace}/configmaps/{name}
Parameter | +Description | +
---|---|
name | +name of the ConfigMap | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 ConfigMap |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind ConfigMap
+GET /api/v1/namespaces/{namespace}/configmaps
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ConfigMapList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind ConfigMap
+GET /api/v1/configmaps
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ConfigMapList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind ConfigMap
+GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}
Parameter | +Description | +
---|---|
name | +name of the ConfigMap | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of ConfigMap
+GET /api/v1/watch/namespaces/{namespace}/configmaps
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of ConfigMap
+GET /api/v1/watch/configmaps
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +Secret | +
Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
data object |
+Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4 | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
stringData object |
+stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API. | +
type string |
+Used to facilitate programmatic handling of secret data. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items Secret array |
+Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a Secret
+POST /api/v1/namespaces/{namespace}/secrets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Secret |
++ |
Code | +Description | +
---|---|
200 Secret |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified Secret
+PATCH /api/v1/namespaces/{namespace}/secrets/{name}
Parameter | +Description | +
---|---|
name | +name of the Secret | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 Secret |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified Secret
+PUT /api/v1/namespaces/{namespace}/secrets/{name}
Parameter | +Description | +
---|---|
name | +name of the Secret | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Secret |
++ |
Code | +Description | +
---|---|
200 Secret |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a Secret
+DELETE /api/v1/namespaces/{namespace}/secrets/{name}
Parameter | +Description | +
---|---|
name | +name of the Secret | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of Secret
+DELETE /api/v1/namespaces/{namespace}/secrets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified Secret
+GET /api/v1/namespaces/{namespace}/secrets/{name}
Parameter | +Description | +
---|---|
name | +name of the Secret | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 Secret |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind Secret
+GET /api/v1/namespaces/{namespace}/secrets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 SecretList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind Secret
+GET /api/v1/secrets
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 SecretList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind Secret
+GET /api/v1/watch/namespaces/{namespace}/secrets/{name}
Parameter | +Description | +
---|---|
name | +name of the Secret | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Secret
+GET /api/v1/watch/namespaces/{namespace}/secrets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Secret
+GET /api/v1/watch/secrets
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +PersistentVolumeClaim | +
PersistentVolumeClaim is a user's request for and claim to a persistent volume
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec PersistentVolumeClaimSpec |
+Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims | +
status PersistentVolumeClaimStatus |
+Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims | +
Field | +Description | +
---|---|
accessModes string array |
+AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 | +
resources ResourceRequirements |
+Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources | +
selector LabelSelector |
+A label query over volumes to consider for binding. | +
storageClassName string |
+Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 | +
volumeName string |
+VolumeName is the binding reference to the PersistentVolume backing this claim. | +
Field | +Description | +
---|---|
accessModes string array |
+AccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 | +
capacity object |
+Represents the actual resources of the underlying volume. | +
conditions PersistentVolumeClaimCondition array patch type: merge patch merge key: type |
+Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'. | +
phase string |
+Phase represents the current phase of PersistentVolumeClaim. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items PersistentVolumeClaim array |
+A list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a PersistentVolumeClaim
+POST /api/v1/namespaces/{namespace}/persistentvolumeclaims
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body PersistentVolumeClaim |
++ |
Code | +Description | +
---|---|
200 PersistentVolumeClaim |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified PersistentVolumeClaim
+PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
Parameter | +Description | +
---|---|
name | +name of the PersistentVolumeClaim | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 PersistentVolumeClaim |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified PersistentVolumeClaim
+PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
Parameter | +Description | +
---|---|
name | +name of the PersistentVolumeClaim | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body PersistentVolumeClaim |
++ |
Code | +Description | +
---|---|
200 PersistentVolumeClaim |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a PersistentVolumeClaim
+DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
Parameter | +Description | +
---|---|
name | +name of the PersistentVolumeClaim | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of PersistentVolumeClaim
+DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified PersistentVolumeClaim
+GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
Parameter | +Description | +
---|---|
name | +name of the PersistentVolumeClaim | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 PersistentVolumeClaim |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind PersistentVolumeClaim
+GET /api/v1/namespaces/{namespace}/persistentvolumeclaims
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 PersistentVolumeClaimList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind PersistentVolumeClaim
+GET /api/v1/persistentvolumeclaims
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 PersistentVolumeClaimList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind PersistentVolumeClaim
+GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}
Parameter | +Description | +
---|---|
name | +name of the PersistentVolumeClaim | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of PersistentVolumeClaim
+GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of PersistentVolumeClaim
+GET /api/v1/watch/persistentvolumeclaims
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update status of the specified PersistentVolumeClaim
+PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
Parameter | +Description | +
---|---|
name | +name of the PersistentVolumeClaim | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 PersistentVolumeClaim |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read status of the specified PersistentVolumeClaim
+GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
Parameter | +Description | +
---|---|
name | +name of the PersistentVolumeClaim | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 PersistentVolumeClaim |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified PersistentVolumeClaim
+PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
Parameter | +Description | +
---|---|
name | +name of the PersistentVolumeClaim | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body PersistentVolumeClaim |
++ |
Code | +Description | +
---|---|
200 PersistentVolumeClaim |
+OK | +
Group | +Version | +Kind | +
---|---|---|
storage | +v1 | +StorageClass | +
StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.
+StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.
+ + +Field | +Description | +
---|---|
allowVolumeExpansion boolean |
+AllowVolumeExpansion shows whether the storage class allow volume expand | +
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
mountOptions string array |
+Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid. | +
parameters object |
+Parameters holds the parameters for the provisioner that should create volumes of this storage class. | +
provisioner string |
+Provisioner indicates the type of the provisioner. | +
reclaimPolicy string |
+Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items StorageClass array |
+Items is the list of StorageClasses | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a StorageClass
+POST /apis/storage.k8s.io/v1/storageclasses
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body StorageClass |
++ |
Code | +Description | +
---|---|
200 StorageClass |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified StorageClass
+PATCH /apis/storage.k8s.io/v1/storageclasses/{name}
Parameter | +Description | +
---|---|
name | +name of the StorageClass | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 StorageClass |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified StorageClass
+PUT /apis/storage.k8s.io/v1/storageclasses/{name}
Parameter | +Description | +
---|---|
name | +name of the StorageClass | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body StorageClass |
++ |
Code | +Description | +
---|---|
200 StorageClass |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a StorageClass
+DELETE /apis/storage.k8s.io/v1/storageclasses/{name}
Parameter | +Description | +
---|---|
name | +name of the StorageClass | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of StorageClass
+DELETE /apis/storage.k8s.io/v1/storageclasses
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified StorageClass
+GET /apis/storage.k8s.io/v1/storageclasses/{name}
Parameter | +Description | +
---|---|
name | +name of the StorageClass | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 StorageClass |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind StorageClass
+GET /apis/storage.k8s.io/v1/storageclasses
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 StorageClassList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind StorageClass
+GET /apis/storage.k8s.io/v1/watch/storageclasses/{name}
Parameter | +Description | +
---|---|
name | +name of the StorageClass | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of StorageClass
+GET /apis/storage.k8s.io/v1/watch/storageclasses
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +Volume | +
Volume represents a named volume in a pod that may be accessed by any container in the pod.
+ + +Field | +Description | +
---|---|
awsElasticBlockStore AWSElasticBlockStoreVolumeSource |
+AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore | +
azureDisk AzureDiskVolumeSource |
+AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. | +
azureFile AzureFileVolumeSource |
+AzureFile represents an Azure File Service mount on the host and bind mount to the pod. | +
cephfs CephFSVolumeSource |
+CephFS represents a Ceph FS mount on the host that shares a pod's lifetime | +
cinder CinderVolumeSource |
+Cinder represents a cinder volume attached and mounted on kubelets host machine More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md | +
configMap ConfigMapVolumeSource |
+ConfigMap represents a configMap that should populate this volume | +
downwardAPI DownwardAPIVolumeSource |
+DownwardAPI represents downward API about the pod that should populate this volume | +
emptyDir EmptyDirVolumeSource |
+EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir | +
fc FCVolumeSource |
+FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. | +
flexVolume FlexVolumeSource |
+FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future. | +
flocker FlockerVolumeSource |
+Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running | +
gcePersistentDisk GCEPersistentDiskVolumeSource |
+GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk | +
gitRepo GitRepoVolumeSource |
+GitRepo represents a git repository at a particular revision. | +
glusterfs GlusterfsVolumeSource |
+Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md | +
hostPath HostPathVolumeSource |
+HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath | +
iscsi ISCSIVolumeSource |
+ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://releases.k8s.io/HEAD/examples/volumes/iscsi/README.md | +
name string |
+Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | +
nfs NFSVolumeSource |
+NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs | +
persistentVolumeClaim PersistentVolumeClaimVolumeSource |
+PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims | +
photonPersistentDisk PhotonPersistentDiskVolumeSource |
+PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine | +
portworxVolume PortworxVolumeSource |
+PortworxVolume represents a portworx volume attached and mounted on kubelets host machine | +
projected ProjectedVolumeSource |
+Items for all in one resources secrets, configmaps, and downward API | +
quobyte QuobyteVolumeSource |
+Quobyte represents a Quobyte mount on the host that shares a pod's lifetime | +
rbd RBDVolumeSource |
+RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md | +
scaleIO ScaleIOVolumeSource |
+ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. | +
secret SecretVolumeSource |
+Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret | +
storageos StorageOSVolumeSource |
+StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. | +
vsphereVolume VsphereVirtualDiskVolumeSource |
+VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine | +
Metadata resources are responsible for configuring behavior of your other Resources within the Cluster.
+Common resource types:
+Group | +Version | +Kind | +
---|---|---|
apps | +v1beta1 | +ControllerRevision | +
DEPRECATED - This group version of ControllerRevision is deprecated by apps/v1beta2/ControllerRevision. See the release notes for more information. ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
data | +Data is the serialized representation of the state. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
revision integer |
+Revision indicates the revision of the state represented by Data. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items ControllerRevision array |
+Items is the list of ControllerRevisions | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a ControllerRevision
+POST /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ControllerRevision |
++ |
Code | +Description | +
---|---|
200 ControllerRevision |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified ControllerRevision
+PATCH /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions/{name}
Parameter | +Description | +
---|---|
name | +name of the ControllerRevision | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 ControllerRevision |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified ControllerRevision
+PUT /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions/{name}
Parameter | +Description | +
---|---|
name | +name of the ControllerRevision | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ControllerRevision |
++ |
Code | +Description | +
---|---|
200 ControllerRevision |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a ControllerRevision
+DELETE /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions/{name}
Parameter | +Description | +
---|---|
name | +name of the ControllerRevision | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of ControllerRevision
+DELETE /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified ControllerRevision
+GET /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions/{name}
Parameter | +Description | +
---|---|
name | +name of the ControllerRevision | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 ControllerRevision |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind ControllerRevision
+GET /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ControllerRevisionList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind ControllerRevision
+GET /apis/apps/v1beta1/controllerrevisions
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ControllerRevisionList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind ControllerRevision
+GET /apis/apps/v1beta1/watch/namespaces/{namespace}/controllerrevisions/{name}
Parameter | +Description | +
---|---|
name | +name of the ControllerRevision | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of ControllerRevision
+GET /apis/apps/v1beta1/watch/namespaces/{namespace}/controllerrevisions
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of ControllerRevision
+GET /apis/apps/v1beta1/watch/controllerrevisions
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
apiextensions | +v1beta1 | +CustomResourceDefinition | +
CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
++ |
spec CustomResourceDefinitionSpec |
+Spec describes how the user wants the resources to appear | +
status CustomResourceDefinitionStatus |
+Status indicates the actual state of the CustomResourceDefinition | +
Field | +Description | +
---|---|
group string |
+Group is the group this resource belongs in | +
names CustomResourceDefinitionNames |
+Names are the names used to describe this custom resource | +
scope string |
+Scope indicates whether this resource is cluster or namespace scoped. Default is namespaced | +
validation CustomResourceValidation |
+Validation describes the validation methods for CustomResources This field is alpha-level and should only be sent to servers that enable the CustomResourceValidation feature. | +
version string |
+Version is the version this resource belongs in | +
Field | +Description | +
---|---|
acceptedNames CustomResourceDefinitionNames |
+AcceptedNames are the names that are actually being used to serve discovery They may be different than the names in spec. | +
conditions CustomResourceDefinitionCondition array |
+Conditions indicate state for particular aspects of a CustomResourceDefinition | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items CustomResourceDefinition array |
+Items individual CustomResourceDefinitions | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
++ |
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a CustomResourceDefinition
+POST /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body CustomResourceDefinition |
++ |
Code | +Description | +
---|---|
200 CustomResourceDefinition |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified CustomResourceDefinition
+PATCH /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}
Parameter | +Description | +
---|---|
name | +name of the CustomResourceDefinition | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 CustomResourceDefinition |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified CustomResourceDefinition
+PUT /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}
Parameter | +Description | +
---|---|
name | +name of the CustomResourceDefinition | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body CustomResourceDefinition |
++ |
Code | +Description | +
---|---|
200 CustomResourceDefinition |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a CustomResourceDefinition
+DELETE /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}
Parameter | +Description | +
---|---|
name | +name of the CustomResourceDefinition | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of CustomResourceDefinition
+DELETE /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified CustomResourceDefinition
+GET /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}
Parameter | +Description | +
---|---|
name | +name of the CustomResourceDefinition | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 CustomResourceDefinition |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind CustomResourceDefinition
+GET /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 CustomResourceDefinitionList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind CustomResourceDefinition
+GET /apis/apiextensions.k8s.io/v1beta1/watch/customresourcedefinitions/{name}
Parameter | +Description | +
---|---|
name | +name of the CustomResourceDefinition | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of CustomResourceDefinition
+GET /apis/apiextensions.k8s.io/v1beta1/watch/customresourcedefinitions
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified CustomResourceDefinition
+PUT /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}/status
Parameter | +Description | +
---|---|
name | +name of the CustomResourceDefinition | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body CustomResourceDefinition |
++ |
Code | +Description | +
---|---|
200 CustomResourceDefinition |
+OK | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +Event | +
Event is a report of an event somewhere in the cluster.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
count integer |
+The number of times this event has occurred. | +
firstTimestamp Time |
+The time at which the event was first recorded. (Time of server receipt is in TypeMeta.) | +
involvedObject ObjectReference |
+The object that this event is about. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
lastTimestamp Time |
+The time at which the most recent occurrence of this event was recorded. | +
message string |
+A human-readable description of the status of this operation. | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
reason string |
+This should be a short, machine understandable string that gives the reason for the transition into the object's current status. | +
source EventSource |
+The component reporting this event. Should be a short machine understandable string. | +
type string |
+Type of this event (Normal, Warning), new types could be added in the future | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items Event array |
+List of events | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create an Event
+POST /api/v1/namespaces/{namespace}/events
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Event |
++ |
Code | +Description | +
---|---|
200 Event |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified Event
+PATCH /api/v1/namespaces/{namespace}/events/{name}
Parameter | +Description | +
---|---|
name | +name of the Event | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 Event |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified Event
+PUT /api/v1/namespaces/{namespace}/events/{name}
Parameter | +Description | +
---|---|
name | +name of the Event | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Event |
++ |
Code | +Description | +
---|---|
200 Event |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete an Event
+DELETE /api/v1/namespaces/{namespace}/events/{name}
Parameter | +Description | +
---|---|
name | +name of the Event | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of Event
+DELETE /api/v1/namespaces/{namespace}/events
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified Event
+GET /api/v1/namespaces/{namespace}/events/{name}
Parameter | +Description | +
---|---|
name | +name of the Event | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 Event |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind Event
+GET /api/v1/namespaces/{namespace}/events
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 EventList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind Event
+GET /api/v1/events
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 EventList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind Event
+GET /api/v1/watch/namespaces/{namespace}/events/{name}
Parameter | +Description | +
---|---|
name | +name of the Event | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Event
+GET /api/v1/watch/namespaces/{namespace}/events
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Event
+GET /api/v1/watch/events
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +LimitRange | +
LimitRange sets resource usage limits for each kind of resource in a Namespace.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec LimitRangeSpec |
+Spec defines the limits enforced. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
Field | +Description | +
---|---|
limits LimitRangeItem array |
+Limits is the list of LimitRangeItem objects that are enforced. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items LimitRange array |
+Items is a list of LimitRange objects. More info: https://git.k8s.io/community/contributors/design-proposals/admission_control_limit_range.md | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a LimitRange
+POST /api/v1/namespaces/{namespace}/limitranges
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body LimitRange |
++ |
Code | +Description | +
---|---|
200 LimitRange |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified LimitRange
+PATCH /api/v1/namespaces/{namespace}/limitranges/{name}
Parameter | +Description | +
---|---|
name | +name of the LimitRange | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 LimitRange |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified LimitRange
+PUT /api/v1/namespaces/{namespace}/limitranges/{name}
Parameter | +Description | +
---|---|
name | +name of the LimitRange | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body LimitRange |
++ |
Code | +Description | +
---|---|
200 LimitRange |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a LimitRange
+DELETE /api/v1/namespaces/{namespace}/limitranges/{name}
Parameter | +Description | +
---|---|
name | +name of the LimitRange | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of LimitRange
+DELETE /api/v1/namespaces/{namespace}/limitranges
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified LimitRange
+GET /api/v1/namespaces/{namespace}/limitranges/{name}
Parameter | +Description | +
---|---|
name | +name of the LimitRange | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 LimitRange |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind LimitRange
+GET /api/v1/namespaces/{namespace}/limitranges
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 LimitRangeList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind LimitRange
+GET /api/v1/limitranges
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 LimitRangeList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind LimitRange
+GET /api/v1/watch/namespaces/{namespace}/limitranges/{name}
Parameter | +Description | +
---|---|
name | +name of the LimitRange | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of LimitRange
+GET /api/v1/watch/namespaces/{namespace}/limitranges
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of LimitRange
+GET /api/v1/watch/limitranges
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
admissionregistration | +v1alpha1 | +ExternalAdmissionHookConfiguration | +
ExternalAdmissionHookConfiguration describes the configuration of initializers.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
externalAdmissionHooks ExternalAdmissionHook array patch type: merge patch merge key: name |
+ExternalAdmissionHooks is a list of external admission webhooks and the affected resources and operations. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items ExternalAdmissionHookConfiguration array |
+List of ExternalAdmissionHookConfiguration. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create an ExternalAdmissionHookConfiguration
+POST /apis/admissionregistration.k8s.io/v1alpha1/externaladmissionhookconfigurations
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ExternalAdmissionHookConfiguration |
++ |
Code | +Description | +
---|---|
200 ExternalAdmissionHookConfiguration |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified ExternalAdmissionHookConfiguration
+PATCH /apis/admissionregistration.k8s.io/v1alpha1/externaladmissionhookconfigurations/{name}
Parameter | +Description | +
---|---|
name | +name of the ExternalAdmissionHookConfiguration | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 ExternalAdmissionHookConfiguration |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified ExternalAdmissionHookConfiguration
+PUT /apis/admissionregistration.k8s.io/v1alpha1/externaladmissionhookconfigurations/{name}
Parameter | +Description | +
---|---|
name | +name of the ExternalAdmissionHookConfiguration | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ExternalAdmissionHookConfiguration |
++ |
Code | +Description | +
---|---|
200 ExternalAdmissionHookConfiguration |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete an ExternalAdmissionHookConfiguration
+DELETE /apis/admissionregistration.k8s.io/v1alpha1/externaladmissionhookconfigurations/{name}
Parameter | +Description | +
---|---|
name | +name of the ExternalAdmissionHookConfiguration | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of ExternalAdmissionHookConfiguration
+DELETE /apis/admissionregistration.k8s.io/v1alpha1/externaladmissionhookconfigurations
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified ExternalAdmissionHookConfiguration
+GET /apis/admissionregistration.k8s.io/v1alpha1/externaladmissionhookconfigurations/{name}
Parameter | +Description | +
---|---|
name | +name of the ExternalAdmissionHookConfiguration | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 ExternalAdmissionHookConfiguration |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind ExternalAdmissionHookConfiguration
+GET /apis/admissionregistration.k8s.io/v1alpha1/externaladmissionhookconfigurations
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ExternalAdmissionHookConfigurationList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind ExternalAdmissionHookConfiguration
+GET /apis/admissionregistration.k8s.io/v1alpha1/watch/externaladmissionhookconfigurations/{name}
Parameter | +Description | +
---|---|
name | +name of the ExternalAdmissionHookConfiguration | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of ExternalAdmissionHookConfiguration
+GET /apis/admissionregistration.k8s.io/v1alpha1/watch/externaladmissionhookconfigurations
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
autoscaling | +v1 | +HorizontalPodAutoscaler | +
configuration of a horizontal pod autoscaler.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec HorizontalPodAutoscalerSpec |
+behaviour of autoscaler. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. | +
status HorizontalPodAutoscalerStatus |
+current information about the autoscaler. | +
Field | +Description | +
---|---|
maxReplicas integer |
+upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas. | +
minReplicas integer |
+lower limit for the number of pods that can be set by the autoscaler, default 1. | +
scaleTargetRef CrossVersionObjectReference |
+reference to scaled resource; horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource. | +
targetCPUUtilizationPercentage integer |
+target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used. | +
Field | +Description | +
---|---|
currentCPUUtilizationPercentage integer |
+current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested CPU. | +
currentReplicas integer |
+current number of replicas of pods managed by this autoscaler. | +
desiredReplicas integer |
+desired number of replicas of pods managed by this autoscaler. | +
lastScaleTime Time |
+last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed. | +
observedGeneration integer |
+most recent generation observed by this autoscaler. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items HorizontalPodAutoscaler array |
+list of horizontal pod autoscaler objects. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a HorizontalPodAutoscaler
+POST /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body HorizontalPodAutoscaler |
++ |
Code | +Description | +
---|---|
200 HorizontalPodAutoscaler |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified HorizontalPodAutoscaler
+PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}
Parameter | +Description | +
---|---|
name | +name of the HorizontalPodAutoscaler | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 HorizontalPodAutoscaler |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified HorizontalPodAutoscaler
+PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}
Parameter | +Description | +
---|---|
name | +name of the HorizontalPodAutoscaler | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body HorizontalPodAutoscaler |
++ |
Code | +Description | +
---|---|
200 HorizontalPodAutoscaler |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a HorizontalPodAutoscaler
+DELETE /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}
Parameter | +Description | +
---|---|
name | +name of the HorizontalPodAutoscaler | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of HorizontalPodAutoscaler
+DELETE /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified HorizontalPodAutoscaler
+GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}
Parameter | +Description | +
---|---|
name | +name of the HorizontalPodAutoscaler | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 HorizontalPodAutoscaler |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind HorizontalPodAutoscaler
+GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 HorizontalPodAutoscalerList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind HorizontalPodAutoscaler
+GET /apis/autoscaling/v1/horizontalpodautoscalers
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 HorizontalPodAutoscalerList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind HorizontalPodAutoscaler
+GET /apis/autoscaling/v1/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}
Parameter | +Description | +
---|---|
name | +name of the HorizontalPodAutoscaler | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of HorizontalPodAutoscaler
+GET /apis/autoscaling/v1/watch/namespaces/{namespace}/horizontalpodautoscalers
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of HorizontalPodAutoscaler
+GET /apis/autoscaling/v1/watch/horizontalpodautoscalers
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update status of the specified HorizontalPodAutoscaler
+PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
Parameter | +Description | +
---|---|
name | +name of the HorizontalPodAutoscaler | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 HorizontalPodAutoscaler |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read status of the specified HorizontalPodAutoscaler
+GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
Parameter | +Description | +
---|---|
name | +name of the HorizontalPodAutoscaler | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 HorizontalPodAutoscaler |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified HorizontalPodAutoscaler
+PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
Parameter | +Description | +
---|---|
name | +name of the HorizontalPodAutoscaler | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body HorizontalPodAutoscaler |
++ |
Code | +Description | +
---|---|
200 HorizontalPodAutoscaler |
+OK | +
Group | +Version | +Kind | +
---|---|---|
admissionregistration | +v1alpha1 | +InitializerConfiguration | +
InitializerConfiguration describes the configuration of initializers.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
initializers Initializer array patch type: merge patch merge key: name |
+Initializers is a list of resources and their default initializers Order-sensitive. When merging multiple InitializerConfigurations, we sort the initializers from different InitializerConfigurations by the name of the InitializerConfigurations; the order of the initializers from the same InitializerConfiguration is preserved. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items InitializerConfiguration array |
+List of InitializerConfiguration. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create an InitializerConfiguration
+POST /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body InitializerConfiguration |
++ |
Code | +Description | +
---|---|
200 InitializerConfiguration |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified InitializerConfiguration
+PATCH /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations/{name}
Parameter | +Description | +
---|---|
name | +name of the InitializerConfiguration | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 InitializerConfiguration |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified InitializerConfiguration
+PUT /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations/{name}
Parameter | +Description | +
---|---|
name | +name of the InitializerConfiguration | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body InitializerConfiguration |
++ |
Code | +Description | +
---|---|
200 InitializerConfiguration |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete an InitializerConfiguration
+DELETE /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations/{name}
Parameter | +Description | +
---|---|
name | +name of the InitializerConfiguration | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of InitializerConfiguration
+DELETE /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified InitializerConfiguration
+GET /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations/{name}
Parameter | +Description | +
---|---|
name | +name of the InitializerConfiguration | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 InitializerConfiguration |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind InitializerConfiguration
+GET /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 InitializerConfigurationList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind InitializerConfiguration
+GET /apis/admissionregistration.k8s.io/v1alpha1/watch/initializerconfigurations/{name}
Parameter | +Description | +
---|---|
name | +name of the InitializerConfiguration | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of InitializerConfiguration
+GET /apis/admissionregistration.k8s.io/v1alpha1/watch/initializerconfigurations
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +PodTemplate | +
PodTemplate describes a template for creating copies of a predefined pod.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
template PodTemplateSpec |
+Template defines the pods that will be created from this pod template. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
Field | +Description | +
---|---|
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec PodSpec |
+Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items PodTemplate array |
+List of pod templates | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a PodTemplate
+POST /api/v1/namespaces/{namespace}/podtemplates
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body PodTemplate |
++ |
Code | +Description | +
---|---|
200 PodTemplate |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified PodTemplate
+PATCH /api/v1/namespaces/{namespace}/podtemplates/{name}
Parameter | +Description | +
---|---|
name | +name of the PodTemplate | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 PodTemplate |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified PodTemplate
+PUT /api/v1/namespaces/{namespace}/podtemplates/{name}
Parameter | +Description | +
---|---|
name | +name of the PodTemplate | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body PodTemplate |
++ |
Code | +Description | +
---|---|
200 PodTemplate |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a PodTemplate
+DELETE /api/v1/namespaces/{namespace}/podtemplates/{name}
Parameter | +Description | +
---|---|
name | +name of the PodTemplate | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of PodTemplate
+DELETE /api/v1/namespaces/{namespace}/podtemplates
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified PodTemplate
+GET /api/v1/namespaces/{namespace}/podtemplates/{name}
Parameter | +Description | +
---|---|
name | +name of the PodTemplate | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 PodTemplate |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind PodTemplate
+GET /api/v1/namespaces/{namespace}/podtemplates
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 PodTemplateList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind PodTemplate
+GET /api/v1/podtemplates
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 PodTemplateList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind PodTemplate
+GET /api/v1/watch/namespaces/{namespace}/podtemplates/{name}
Parameter | +Description | +
---|---|
name | +name of the PodTemplate | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of PodTemplate
+GET /api/v1/watch/namespaces/{namespace}/podtemplates
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of PodTemplate
+GET /api/v1/watch/podtemplates
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
policy | +v1beta1 | +PodDisruptionBudget | +
PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
++ |
spec PodDisruptionBudgetSpec |
+Specification of the desired behavior of the PodDisruptionBudget. | +
status PodDisruptionBudgetStatus |
+Most recently observed status of the PodDisruptionBudget. | +
Field | +Description | +
---|---|
maxUnavailable | +An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable". | +
minAvailable | +An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%". | +
selector LabelSelector |
+Label query over pods whose evictions are managed by the disruption budget. | +
Field | +Description | +
---|---|
currentHealthy integer |
+current number of healthy pods | +
desiredHealthy integer |
+minimum desired number of healthy pods | +
disruptedPods object |
+DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion (or after a timeout). The key in the map is the name of the pod and the value is the time when the API server processed the eviction request. If the deletion didn't occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time. If everything goes smooth this map should be empty for the most of the time. Large number of entries in the map may indicate problems with pod deletions. | +
disruptionsAllowed integer |
+Number of pod disruptions that are currently allowed. | +
expectedPods integer |
+total number of pods counted by this disruption budget | +
observedGeneration integer |
+Most recent generation observed when updating this PDB status. PodDisruptionsAllowed and other status informatio is valid only if observedGeneration equals to PDB's object generation. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items PodDisruptionBudget array |
++ |
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
++ |
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a PodDisruptionBudget
+POST /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body PodDisruptionBudget |
++ |
Code | +Description | +
---|---|
200 PodDisruptionBudget |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified PodDisruptionBudget
+PATCH /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}
Parameter | +Description | +
---|---|
name | +name of the PodDisruptionBudget | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 PodDisruptionBudget |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified PodDisruptionBudget
+PUT /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}
Parameter | +Description | +
---|---|
name | +name of the PodDisruptionBudget | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body PodDisruptionBudget |
++ |
Code | +Description | +
---|---|
200 PodDisruptionBudget |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a PodDisruptionBudget
+DELETE /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}
Parameter | +Description | +
---|---|
name | +name of the PodDisruptionBudget | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of PodDisruptionBudget
+DELETE /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified PodDisruptionBudget
+GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}
Parameter | +Description | +
---|---|
name | +name of the PodDisruptionBudget | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 PodDisruptionBudget |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind PodDisruptionBudget
+GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 PodDisruptionBudgetList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind PodDisruptionBudget
+GET /apis/policy/v1beta1/poddisruptionbudgets
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 PodDisruptionBudgetList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind PodDisruptionBudget
+GET /apis/policy/v1beta1/watch/namespaces/{namespace}/poddisruptionbudgets/{name}
Parameter | +Description | +
---|---|
name | +name of the PodDisruptionBudget | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of PodDisruptionBudget
+GET /apis/policy/v1beta1/watch/namespaces/{namespace}/poddisruptionbudgets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of PodDisruptionBudget
+GET /apis/policy/v1beta1/watch/poddisruptionbudgets
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update status of the specified PodDisruptionBudget
+PATCH /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
Parameter | +Description | +
---|---|
name | +name of the PodDisruptionBudget | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 PodDisruptionBudget |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read status of the specified PodDisruptionBudget
+GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
Parameter | +Description | +
---|---|
name | +name of the PodDisruptionBudget | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 PodDisruptionBudget |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified PodDisruptionBudget
+PUT /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
Parameter | +Description | +
---|---|
name | +name of the PodDisruptionBudget | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body PodDisruptionBudget |
++ |
Code | +Description | +
---|---|
200 PodDisruptionBudget |
+OK | +
Group | +Version | +Kind | +
---|---|---|
scheduling | +v1alpha1 | +PriorityClass | +
PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
description string |
+description is an arbitrary string that usually provides guidelines on when this priority class should be used. | +
globalDefault boolean |
+globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata | +
value integer |
+The value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items PriorityClass array |
+items is the list of PriorityClasses | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a PriorityClass
+POST /apis/scheduling.k8s.io/v1alpha1/priorityclasses
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body PriorityClass |
++ |
Code | +Description | +
---|---|
200 PriorityClass |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified PriorityClass
+PATCH /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}
Parameter | +Description | +
---|---|
name | +name of the PriorityClass | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 PriorityClass |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified PriorityClass
+PUT /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}
Parameter | +Description | +
---|---|
name | +name of the PriorityClass | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body PriorityClass |
++ |
Code | +Description | +
---|---|
200 PriorityClass |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a PriorityClass
+DELETE /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}
Parameter | +Description | +
---|---|
name | +name of the PriorityClass | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of PriorityClass
+DELETE /apis/scheduling.k8s.io/v1alpha1/priorityclasses
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified PriorityClass
+GET /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}
Parameter | +Description | +
---|---|
name | +name of the PriorityClass | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 PriorityClass |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind PriorityClass
+GET /apis/scheduling.k8s.io/v1alpha1/priorityclasses
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 PriorityClassList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind PriorityClass
+GET /apis/scheduling.k8s.io/v1alpha1/watch/priorityclasses/{name}
Parameter | +Description | +
---|---|
name | +name of the PriorityClass | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of PriorityClass
+GET /apis/scheduling.k8s.io/v1alpha1/watch/priorityclasses
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
settings | +v1alpha1 | +PodPreset | +
PodPreset is a policy resource that defines additional runtime requirements for a Pod.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
++ |
spec PodPresetSpec |
++ |
Field | +Description | +
---|---|
env EnvVar array |
+Env defines the collection of EnvVar to inject into containers. | +
envFrom EnvFromSource array |
+EnvFrom defines the collection of EnvFromSource to inject into containers. | +
selector LabelSelector |
+Selector is a label query over a set of resources, in this case pods. Required. | +
volumeMounts VolumeMount array |
+VolumeMounts defines the collection of VolumeMount to inject into containers. | +
volumes Volume array |
+Volumes defines the collection of Volume to inject into the pod. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items PodPreset array |
+Items is a list of schema objects. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a PodPreset
+POST /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body PodPreset |
++ |
Code | +Description | +
---|---|
200 PodPreset |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified PodPreset
+PATCH /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets/{name}
Parameter | +Description | +
---|---|
name | +name of the PodPreset | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 PodPreset |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified PodPreset
+PUT /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets/{name}
Parameter | +Description | +
---|---|
name | +name of the PodPreset | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body PodPreset |
++ |
Code | +Description | +
---|---|
200 PodPreset |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a PodPreset
+DELETE /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets/{name}
Parameter | +Description | +
---|---|
name | +name of the PodPreset | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of PodPreset
+DELETE /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified PodPreset
+GET /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets/{name}
Parameter | +Description | +
---|---|
name | +name of the PodPreset | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 PodPreset |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind PodPreset
+GET /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 PodPresetList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind PodPreset
+GET /apis/settings.k8s.io/v1alpha1/podpresets
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 PodPresetList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind PodPreset
+GET /apis/settings.k8s.io/v1alpha1/watch/namespaces/{namespace}/podpresets/{name}
Parameter | +Description | +
---|---|
name | +name of the PodPreset | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of PodPreset
+GET /apis/settings.k8s.io/v1alpha1/watch/namespaces/{namespace}/podpresets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of PodPreset
+GET /apis/settings.k8s.io/v1alpha1/watch/podpresets
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +PodSecurityPolicy | +
Pod Security Policy governs the ability to make requests that affect the Security Context that will be applied to a pod and container.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec PodSecurityPolicySpec |
+spec defines the policy enforced. | +
Field | +Description | +
---|---|
allowPrivilegeEscalation boolean |
+AllowPrivilegeEscalation determines if a pod can request to allow privilege escalation. | +
allowedCapabilities string array |
+AllowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field may be added at the pod author's discretion. You must not list a capability in both AllowedCapabilities and RequiredDropCapabilities. | +
allowedHostPaths AllowedHostPath array |
+is a white list of allowed host paths. Empty indicates that all host paths may be used. | +
defaultAddCapabilities string array |
+DefaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. You may not list a capabiility in both DefaultAddCapabilities and RequiredDropCapabilities. | +
defaultAllowPrivilegeEscalation boolean |
+DefaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process. | +
fsGroup FSGroupStrategyOptions |
+FSGroup is the strategy that will dictate what fs group is used by the SecurityContext. | +
hostIPC boolean |
+hostIPC determines if the policy allows the use of HostIPC in the pod spec. | +
hostNetwork boolean |
+hostNetwork determines if the policy allows the use of HostNetwork in the pod spec. | +
hostPID boolean |
+hostPID determines if the policy allows the use of HostPID in the pod spec. | +
hostPorts HostPortRange array |
+hostPorts determines which host port ranges are allowed to be exposed. | +
privileged boolean |
+privileged determines if a pod can request to be run as privileged. | +
readOnlyRootFilesystem boolean |
+ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file system. If the container specifically requests to run with a non-read only root file system the PSP should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to. | +
requiredDropCapabilities string array |
+RequiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added. | +
runAsUser RunAsUserStrategyOptions |
+runAsUser is the strategy that will dictate the allowable RunAsUser values that may be set. | +
seLinux SELinuxStrategyOptions |
+seLinux is the strategy that will dictate the allowable labels that may be set. | +
supplementalGroups SupplementalGroupsStrategyOptions |
+SupplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. | +
volumes string array |
+volumes is a white list of allowed volume plugins. Empty indicates that all plugins may be used. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items PodSecurityPolicy array |
+Items is a list of schema objects. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a PodSecurityPolicy
+POST /apis/extensions/v1beta1/podsecuritypolicies
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body PodSecurityPolicy |
++ |
Code | +Description | +
---|---|
200 PodSecurityPolicy |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified PodSecurityPolicy
+PATCH /apis/extensions/v1beta1/podsecuritypolicies/{name}
Parameter | +Description | +
---|---|
name | +name of the PodSecurityPolicy | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 PodSecurityPolicy |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified PodSecurityPolicy
+PUT /apis/extensions/v1beta1/podsecuritypolicies/{name}
Parameter | +Description | +
---|---|
name | +name of the PodSecurityPolicy | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body PodSecurityPolicy |
++ |
Code | +Description | +
---|---|
200 PodSecurityPolicy |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a PodSecurityPolicy
+DELETE /apis/extensions/v1beta1/podsecuritypolicies/{name}
Parameter | +Description | +
---|---|
name | +name of the PodSecurityPolicy | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of PodSecurityPolicy
+DELETE /apis/extensions/v1beta1/podsecuritypolicies
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified PodSecurityPolicy
+GET /apis/extensions/v1beta1/podsecuritypolicies/{name}
Parameter | +Description | +
---|---|
name | +name of the PodSecurityPolicy | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 PodSecurityPolicy |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind PodSecurityPolicy
+GET /apis/extensions/v1beta1/podsecuritypolicies
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 PodSecurityPolicyList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind PodSecurityPolicy
+GET /apis/extensions/v1beta1/watch/podsecuritypolicies/{name}
Parameter | +Description | +
---|---|
name | +name of the PodSecurityPolicy | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of PodSecurityPolicy
+GET /apis/extensions/v1beta1/watch/podsecuritypolicies
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Cluster resources are responsible for defining configuration of the cluster itself, and are generally only used by cluster operators.
+Group | +Version | +Kind | +
---|---|---|
apiregistration | +v1beta1 | +APIService | +
APIService represents a server for a particular GroupVersion. Name must be "version.group".
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
++ |
spec APIServiceSpec |
+Spec contains information for locating and communicating with a server | +
status APIServiceStatus |
+Status contains derived information about an API server | +
Field | +Description | +
---|---|
caBundle string |
+CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. | +
group string |
+Group is the API group name this server hosts | +
groupPriorityMinimum integer |
+GroupPriorityMininum is the priority this group should have at least. Higher priority means that the group is prefered by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s | +
insecureSkipTLSVerify boolean |
+InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead. | +
service ServiceReference |
+Service is a reference to the service for this API server. It must communicate on port 443 If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled. | +
version string |
+Version is the API version this server hosts. For example, "v1" | +
versionPriority integer |
+VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) Since it's inside of a group, the number can be small, probably in the 10s. | +
Field | +Description | +
---|---|
conditions APIServiceCondition array patch type: merge patch merge key: type |
+Current service state of apiService. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items APIService array |
++ |
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
++ |
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create an APIService
+POST /apis/apiregistration.k8s.io/v1beta1/apiservices
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body APIService |
++ |
Code | +Description | +
---|---|
200 APIService |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified APIService
+PATCH /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}
Parameter | +Description | +
---|---|
name | +name of the APIService | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 APIService |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified APIService
+PUT /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}
Parameter | +Description | +
---|---|
name | +name of the APIService | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body APIService |
++ |
Code | +Description | +
---|---|
200 APIService |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete an APIService
+DELETE /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}
Parameter | +Description | +
---|---|
name | +name of the APIService | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of APIService
+DELETE /apis/apiregistration.k8s.io/v1beta1/apiservices
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified APIService
+GET /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}
Parameter | +Description | +
---|---|
name | +name of the APIService | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 APIService |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind APIService
+GET /apis/apiregistration.k8s.io/v1beta1/apiservices
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 APIServiceList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind APIService
+GET /apis/apiregistration.k8s.io/v1beta1/watch/apiservices/{name}
Parameter | +Description | +
---|---|
name | +name of the APIService | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of APIService
+GET /apis/apiregistration.k8s.io/v1beta1/watch/apiservices
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified APIService
+PUT /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}/status
Parameter | +Description | +
---|---|
name | +name of the APIService | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body APIService |
++ |
Code | +Description | +
---|---|
200 APIService |
+OK | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +Binding | +
Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead.
+Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
target ObjectReference |
+The target object that you want to bind to the standard object. | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a Binding
+POST /api/v1/namespaces/{namespace}/bindings
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Binding |
++ |
Code | +Description | +
---|---|
200 Binding |
+OK | +
Group | +Version | +Kind | +
---|---|---|
certificates | +v1beta1 | +CertificateSigningRequest | +
Describes a certificate signing request
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
++ |
spec CertificateSigningRequestSpec |
+The certificate request itself and any additional information. | +
status CertificateSigningRequestStatus |
+Derived information about the request. | +
Field | +Description | +
---|---|
extra object |
+Extra information about the requesting user. See user.Info interface for details. | +
groups string array |
+Group information about the requesting user. See user.Info interface for details. | +
request string |
+Base64-encoded PKCS#10 CSR data | +
uid string |
+UID information about the requesting user. See user.Info interface for details. | +
usages string array |
+allowedUsages specifies a set of usage contexts the key will be valid for. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3 https://tools.ietf.org/html/rfc5280#section-4.2.1.12 | +
username string |
+Information about the requesting user. See user.Info interface for details. | +
Field | +Description | +
---|---|
certificate string |
+If request was approved, the controller will place the issued certificate here. | +
conditions CertificateSigningRequestCondition array |
+Conditions applied to the request, such as approval or denial. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items CertificateSigningRequest array |
++ |
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
++ |
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a CertificateSigningRequest
+POST /apis/certificates.k8s.io/v1beta1/certificatesigningrequests
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body CertificateSigningRequest |
++ |
Code | +Description | +
---|---|
200 CertificateSigningRequest |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified CertificateSigningRequest
+PATCH /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}
Parameter | +Description | +
---|---|
name | +name of the CertificateSigningRequest | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 CertificateSigningRequest |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified CertificateSigningRequest
+PUT /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}
Parameter | +Description | +
---|---|
name | +name of the CertificateSigningRequest | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body CertificateSigningRequest |
++ |
Code | +Description | +
---|---|
200 CertificateSigningRequest |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a CertificateSigningRequest
+DELETE /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}
Parameter | +Description | +
---|---|
name | +name of the CertificateSigningRequest | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of CertificateSigningRequest
+DELETE /apis/certificates.k8s.io/v1beta1/certificatesigningrequests
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified CertificateSigningRequest
+GET /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}
Parameter | +Description | +
---|---|
name | +name of the CertificateSigningRequest | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 CertificateSigningRequest |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind CertificateSigningRequest
+GET /apis/certificates.k8s.io/v1beta1/certificatesigningrequests
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 CertificateSigningRequestList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind CertificateSigningRequest
+GET /apis/certificates.k8s.io/v1beta1/watch/certificatesigningrequests/{name}
Parameter | +Description | +
---|---|
name | +name of the CertificateSigningRequest | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of CertificateSigningRequest
+GET /apis/certificates.k8s.io/v1beta1/watch/certificatesigningrequests
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified CertificateSigningRequest
+PUT /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status
Parameter | +Description | +
---|---|
name | +name of the CertificateSigningRequest | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body CertificateSigningRequest |
++ |
Code | +Description | +
---|---|
200 CertificateSigningRequest |
+OK | +
Group | +Version | +Kind | +
---|---|---|
rbac | +v1 | +ClusterRole | +
ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. | +
rules PolicyRule array |
+Rules holds all the PolicyRules for this ClusterRole | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items ClusterRole array |
+Items is a list of ClusterRoles | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard object's metadata. | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a ClusterRole
+POST /apis/rbac.authorization.k8s.io/v1/clusterroles
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ClusterRole |
++ |
Code | +Description | +
---|---|
200 ClusterRole |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified ClusterRole
+PATCH /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRole | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 ClusterRole |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified ClusterRole
+PUT /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRole | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ClusterRole |
++ |
Code | +Description | +
---|---|
200 ClusterRole |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a ClusterRole
+DELETE /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRole | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of ClusterRole
+DELETE /apis/rbac.authorization.k8s.io/v1/clusterroles
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified ClusterRole
+GET /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRole | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 ClusterRole |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind ClusterRole
+GET /apis/rbac.authorization.k8s.io/v1/clusterroles
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ClusterRoleList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind ClusterRole
+GET /apis/rbac.authorization.k8s.io/v1/watch/clusterroles/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRole | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of ClusterRole
+GET /apis/rbac.authorization.k8s.io/v1/watch/clusterroles
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
rbac | +v1 | +ClusterRoleBinding | +
ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. | +
roleRef RoleRef |
+RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. | +
subjects Subject array |
+Subjects holds references to the objects the role applies to. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items ClusterRoleBinding array |
+Items is a list of ClusterRoleBindings | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard object's metadata. | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a ClusterRoleBinding
+POST /apis/rbac.authorization.k8s.io/v1/clusterrolebindings
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ClusterRoleBinding |
++ |
Code | +Description | +
---|---|
200 ClusterRoleBinding |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified ClusterRoleBinding
+PATCH /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRoleBinding | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 ClusterRoleBinding |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified ClusterRoleBinding
+PUT /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRoleBinding | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ClusterRoleBinding |
++ |
Code | +Description | +
---|---|
200 ClusterRoleBinding |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a ClusterRoleBinding
+DELETE /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRoleBinding | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of ClusterRoleBinding
+DELETE /apis/rbac.authorization.k8s.io/v1/clusterrolebindings
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified ClusterRoleBinding
+GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRoleBinding | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 ClusterRoleBinding |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind ClusterRoleBinding
+GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ClusterRoleBindingList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind ClusterRoleBinding
+GET /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRoleBinding | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of ClusterRoleBinding
+GET /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ComponentStatus | +
ComponentStatus (and ComponentStatusList) holds the cluster validation info.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
conditions ComponentCondition array patch type: merge patch merge key: type |
+List of component conditions observed | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items ComponentStatus array |
+List of ComponentStatus objects. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified ComponentStatus
+GET /api/v1/componentstatuses/{name}
Parameter | +Description | +
---|---|
name | +name of the ComponentStatus | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 ComponentStatus |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list objects of kind ComponentStatus
+GET /api/v1/componentstatuses
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ComponentStatusList |
+OK | +
Group | +Version | +Kind | +
---|---|---|
authorization | +v1 | +LocalSubjectAccessReview | +
LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking.
+Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
++ |
spec SubjectAccessReviewSpec |
+Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted. | +
status SubjectAccessReviewStatus |
+Status is filled in by the server and indicates whether the request is allowed or not | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a LocalSubjectAccessReview
+POST /apis/authorization.k8s.io/v1/namespaces/{namespace}/localsubjectaccessreviews
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body LocalSubjectAccessReview |
++ |
Code | +Description | +
---|---|
200 LocalSubjectAccessReview |
+OK | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +Namespace | +
Namespace provides a scope for Names. Use of multiple namespaces is optional.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec NamespaceSpec |
+Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
status NamespaceStatus |
+Status describes the current status of a Namespace. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
Field | +Description | +
---|---|
finalizers string array |
+Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://git.k8s.io/community/contributors/design-proposals/namespaces.md#finalizers | +
Field | +Description | +
---|---|
phase string |
+Phase is the current lifecycle phase of the namespace. More info: https://git.k8s.io/community/contributors/design-proposals/namespaces.md#phases | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items Namespace array |
+Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a Namespace
+POST /api/v1/namespaces
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Namespace |
++ |
Code | +Description | +
---|---|
200 Namespace |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified Namespace
+PATCH /api/v1/namespaces/{name}
Parameter | +Description | +
---|---|
name | +name of the Namespace | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 Namespace |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified Namespace
+PUT /api/v1/namespaces/{name}
Parameter | +Description | +
---|---|
name | +name of the Namespace | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Namespace |
++ |
Code | +Description | +
---|---|
200 Namespace |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a Namespace
+DELETE /api/v1/namespaces/{name}
Parameter | +Description | +
---|---|
name | +name of the Namespace | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified Namespace
+GET /api/v1/namespaces/{name}
Parameter | +Description | +
---|---|
name | +name of the Namespace | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 Namespace |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind Namespace
+GET /api/v1/namespaces
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 NamespaceList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind Namespace
+GET /api/v1/watch/namespaces/{name}
Parameter | +Description | +
---|---|
name | +name of the Namespace | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Namespace
+GET /api/v1/watch/namespaces
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update status of the specified Namespace
+PATCH /api/v1/namespaces/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Namespace | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 Namespace |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read status of the specified Namespace
+GET /api/v1/namespaces/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Namespace | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 Namespace |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified Namespace
+PUT /api/v1/namespaces/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Namespace | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Namespace |
++ |
Code | +Description | +
---|---|
200 Namespace |
+OK | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +Node | +
Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd).
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec NodeSpec |
+Spec defines the behavior of a node. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
status NodeStatus |
+Most recently observed status of the node. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
Field | +Description | +
---|---|
configSource NodeConfigSource |
+If specified, the source to get node configuration from The DynamicKubeletConfig feature gate must be enabled for the Kubelet to use this field | +
externalID string |
+External ID of the node assigned by some machine database (e.g. a cloud provider). Deprecated. | +
podCIDR string |
+PodCIDR represents the pod IP range assigned to the node. | +
providerID string |
+ID of the node assigned by the cloud provider in the format: |
+
taints Taint array |
+If specified, the node's taints. | +
unschedulable boolean |
+Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration | +
Field | +Description | +
---|---|
addresses NodeAddress array patch type: merge patch merge key: type |
+List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/concepts/nodes/node/#addresses | +
allocatable object |
+Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity. | +
capacity object |
+Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity | +
conditions NodeCondition array patch type: merge patch merge key: type |
+Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition | +
daemonEndpoints NodeDaemonEndpoints |
+Endpoints of daemons running on the Node. | +
images ContainerImage array |
+List of container images on this node | +
nodeInfo NodeSystemInfo |
+Set of ids/uuids to uniquely identify the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#info | +
phase string |
+NodePhase is the recently observed lifecycle phase of the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#phase The field is never populated, and now is deprecated. | +
volumesAttached AttachedVolume array |
+List of volumes that are attached to the node. | +
volumesInUse string array |
+List of attachable volumes in use (mounted) by the node. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items Node array |
+List of nodes | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a Node
+POST /api/v1/nodes
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Node |
++ |
Code | +Description | +
---|---|
200 Node |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified Node
+PATCH /api/v1/nodes/{name}
Parameter | +Description | +
---|---|
name | +name of the Node | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 Node |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified Node
+PUT /api/v1/nodes/{name}
Parameter | +Description | +
---|---|
name | +name of the Node | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Node |
++ |
Code | +Description | +
---|---|
200 Node |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a Node
+DELETE /api/v1/nodes/{name}
Parameter | +Description | +
---|---|
name | +name of the Node | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of Node
+DELETE /api/v1/nodes
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified Node
+GET /api/v1/nodes/{name}
Parameter | +Description | +
---|---|
name | +name of the Node | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 Node |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind Node
+GET /api/v1/nodes
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 NodeList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind Node
+GET /api/v1/watch/nodes/{name}
Parameter | +Description | +
---|---|
name | +name of the Node | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Node
+GET /api/v1/watch/nodes
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update status of the specified Node
+PATCH /api/v1/nodes/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Node | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 Node |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read status of the specified Node
+GET /api/v1/nodes/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Node | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 Node |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified Node
+PUT /api/v1/nodes/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Node | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Node |
++ |
Code | +Description | +
---|---|
200 Node |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect POST requests to proxy of Node
+POST /api/v1/nodes/{name}/proxy
Parameter | +Description | +
---|---|
name | +name of the Node | +
Parameter | +Description | +
---|---|
path | +Path is the URL path to use for the current proxy request to node. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect POST requests to proxy of Node
+POST /api/v1/nodes/{name}/proxy/{path}
Parameter | +Description | +
---|---|
name | +name of the Node | +
path | +path to the resource | +
Parameter | +Description | +
---|---|
path | +Path is the URL path to use for the current proxy request to node. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+proxy POST requests to Node
+POST /api/v1/proxy/nodes/{name}
Parameter | +Description | +
---|---|
name | +name of the Node | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+proxy POST requests to Node
+POST /api/v1/proxy/nodes/{name}/{path}
Parameter | +Description | +
---|---|
name | +name of the Node | +
path | +path to the resource | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect DELETE requests to proxy of Node
+DELETE /api/v1/nodes/{name}/proxy
Parameter | +Description | +
---|---|
name | +name of the Node | +
Parameter | +Description | +
---|---|
path | +Path is the URL path to use for the current proxy request to node. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect DELETE requests to proxy of Node
+DELETE /api/v1/nodes/{name}/proxy/{path}
Parameter | +Description | +
---|---|
name | +name of the Node | +
path | +path to the resource | +
Parameter | +Description | +
---|---|
path | +Path is the URL path to use for the current proxy request to node. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+proxy DELETE requests to Node
+DELETE /api/v1/proxy/nodes/{name}
Parameter | +Description | +
---|---|
name | +name of the Node | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+proxy DELETE requests to Node
+DELETE /api/v1/proxy/nodes/{name}/{path}
Parameter | +Description | +
---|---|
name | +name of the Node | +
path | +path to the resource | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect GET requests to proxy of Node
+GET /api/v1/nodes/{name}/proxy
Parameter | +Description | +
---|---|
name | +name of the Node | +
Parameter | +Description | +
---|---|
path | +Path is the URL path to use for the current proxy request to node. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect GET requests to proxy of Node
+GET /api/v1/nodes/{name}/proxy/{path}
Parameter | +Description | +
---|---|
name | +name of the Node | +
path | +path to the resource | +
Parameter | +Description | +
---|---|
path | +Path is the URL path to use for the current proxy request to node. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+proxy GET requests to Node
+GET /api/v1/proxy/nodes/{name}
Parameter | +Description | +
---|---|
name | +name of the Node | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+proxy GET requests to Node
+GET /api/v1/proxy/nodes/{name}/{path}
Parameter | +Description | +
---|---|
name | +name of the Node | +
path | +path to the resource | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect HEAD requests to proxy of Node
+HEAD /api/v1/nodes/{name}/proxy
Parameter | +Description | +
---|---|
name | +name of the Node | +
Parameter | +Description | +
---|---|
path | +Path is the URL path to use for the current proxy request to node. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect HEAD requests to proxy of Node
+HEAD /api/v1/nodes/{name}/proxy/{path}
Parameter | +Description | +
---|---|
name | +name of the Node | +
path | +path to the resource | +
Parameter | +Description | +
---|---|
path | +Path is the URL path to use for the current proxy request to node. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect PUT requests to proxy of Node
+PUT /api/v1/nodes/{name}/proxy
Parameter | +Description | +
---|---|
name | +name of the Node | +
Parameter | +Description | +
---|---|
path | +Path is the URL path to use for the current proxy request to node. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+connect PUT requests to proxy of Node
+PUT /api/v1/nodes/{name}/proxy/{path}
Parameter | +Description | +
---|---|
name | +name of the Node | +
path | +path to the resource | +
Parameter | +Description | +
---|---|
path | +Path is the URL path to use for the current proxy request to node. | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+proxy PUT requests to Node
+PUT /api/v1/proxy/nodes/{name}
Parameter | +Description | +
---|---|
name | +name of the Node | +
Code | +Description | +
---|---|
200 string |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+proxy PUT requests to Node
+PUT /api/v1/proxy/nodes/{name}/{path}
Parameter | +Description | +
---|---|
name | +name of the Node | +
path | +path to the resource | +
Code | +Description | +
---|---|
200 string |
+OK | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +PersistentVolume | +
PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec PersistentVolumeSpec |
+Spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes | +
status PersistentVolumeStatus |
+Status represents the current information/status for the persistent volume. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes | +
Field | +Description | +
---|---|
accessModes string array |
+AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes | +
awsElasticBlockStore AWSElasticBlockStoreVolumeSource |
+AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore | +
azureDisk AzureDiskVolumeSource |
+AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. | +
azureFile AzureFilePersistentVolumeSource |
+AzureFile represents an Azure File Service mount on the host and bind mount to the pod. | +
capacity object |
+A description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity | +
cephfs CephFSPersistentVolumeSource |
+CephFS represents a Ceph FS mount on the host that shares a pod's lifetime | +
cinder CinderVolumeSource |
+Cinder represents a cinder volume attached and mounted on kubelets host machine More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md | +
claimRef ObjectReference |
+ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding | +
fc FCVolumeSource |
+FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. | +
flexVolume FlexVolumeSource |
+FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future. | +
flocker FlockerVolumeSource |
+Flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running | +
gcePersistentDisk GCEPersistentDiskVolumeSource |
+GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk | +
glusterfs GlusterfsVolumeSource |
+Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md | +
hostPath HostPathVolumeSource |
+HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath | +
iscsi ISCSIVolumeSource |
+ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. | +
local LocalVolumeSource |
+Local represents directly-attached storage with node affinity | +
mountOptions string array |
+A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options | +
nfs NFSVolumeSource |
+NFS represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs | +
persistentVolumeReclaimPolicy string |
+What happens to a persistent volume when released from its claim. Valid options are Retain (default) and Recycle. Recycling must be supported by the volume plugin underlying this persistent volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming | +
photonPersistentDisk PhotonPersistentDiskVolumeSource |
+PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine | +
portworxVolume PortworxVolumeSource |
+PortworxVolume represents a portworx volume attached and mounted on kubelets host machine | +
quobyte QuobyteVolumeSource |
+Quobyte represents a Quobyte mount on the host that shares a pod's lifetime | +
rbd RBDVolumeSource |
+RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md | +
scaleIO ScaleIOVolumeSource |
+ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. | +
storageClassName string |
+Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass. | +
storageos StorageOSPersistentVolumeSource |
+StorageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://releases.k8s.io/HEAD/examples/volumes/storageos/README.md | +
vsphereVolume VsphereVirtualDiskVolumeSource |
+VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine | +
Field | +Description | +
---|---|
message string |
+A human-readable message indicating details about why the volume is in this state. | +
phase string |
+Phase indicates if a volume is available, bound to a claim, or released by a claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase | +
reason string |
+Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items PersistentVolume array |
+List of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a PersistentVolume
+POST /api/v1/persistentvolumes
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body PersistentVolume |
++ |
Code | +Description | +
---|---|
200 PersistentVolume |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified PersistentVolume
+PATCH /api/v1/persistentvolumes/{name}
Parameter | +Description | +
---|---|
name | +name of the PersistentVolume | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 PersistentVolume |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified PersistentVolume
+PUT /api/v1/persistentvolumes/{name}
Parameter | +Description | +
---|---|
name | +name of the PersistentVolume | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body PersistentVolume |
++ |
Code | +Description | +
---|---|
200 PersistentVolume |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a PersistentVolume
+DELETE /api/v1/persistentvolumes/{name}
Parameter | +Description | +
---|---|
name | +name of the PersistentVolume | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of PersistentVolume
+DELETE /api/v1/persistentvolumes
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified PersistentVolume
+GET /api/v1/persistentvolumes/{name}
Parameter | +Description | +
---|---|
name | +name of the PersistentVolume | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 PersistentVolume |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind PersistentVolume
+GET /api/v1/persistentvolumes
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 PersistentVolumeList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind PersistentVolume
+GET /api/v1/watch/persistentvolumes/{name}
Parameter | +Description | +
---|---|
name | +name of the PersistentVolume | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of PersistentVolume
+GET /api/v1/watch/persistentvolumes
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update status of the specified PersistentVolume
+PATCH /api/v1/persistentvolumes/{name}/status
Parameter | +Description | +
---|---|
name | +name of the PersistentVolume | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 PersistentVolume |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read status of the specified PersistentVolume
+GET /api/v1/persistentvolumes/{name}/status
Parameter | +Description | +
---|---|
name | +name of the PersistentVolume | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 PersistentVolume |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified PersistentVolume
+PUT /api/v1/persistentvolumes/{name}/status
Parameter | +Description | +
---|---|
name | +name of the PersistentVolume | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body PersistentVolume |
++ |
Code | +Description | +
---|---|
200 PersistentVolume |
+OK | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ResourceQuota | +
ResourceQuota sets aggregate quota restrictions enforced per namespace
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec ResourceQuotaSpec |
+Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
status ResourceQuotaStatus |
+Status defines the actual enforced quota and its current usage. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
Field | +Description | +
---|---|
hard object |
+Hard is the set of desired hard limits for each named resource. More info: https://git.k8s.io/community/contributors/design-proposals/admission_control_resource_quota.md | +
scopes string array |
+A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects. | +
Field | +Description | +
---|---|
hard object |
+Hard is the set of enforced hard limits for each named resource. More info: https://git.k8s.io/community/contributors/design-proposals/admission_control_resource_quota.md | +
used object |
+Used is the current observed total usage of the resource in the namespace. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items ResourceQuota array |
+Items is a list of ResourceQuota objects. More info: https://git.k8s.io/community/contributors/design-proposals/admission_control_resource_quota.md | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a ResourceQuota
+POST /api/v1/namespaces/{namespace}/resourcequotas
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ResourceQuota |
++ |
Code | +Description | +
---|---|
200 ResourceQuota |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified ResourceQuota
+PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}
Parameter | +Description | +
---|---|
name | +name of the ResourceQuota | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 ResourceQuota |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified ResourceQuota
+PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}
Parameter | +Description | +
---|---|
name | +name of the ResourceQuota | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ResourceQuota |
++ |
Code | +Description | +
---|---|
200 ResourceQuota |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a ResourceQuota
+DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name}
Parameter | +Description | +
---|---|
name | +name of the ResourceQuota | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of ResourceQuota
+DELETE /api/v1/namespaces/{namespace}/resourcequotas
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified ResourceQuota
+GET /api/v1/namespaces/{namespace}/resourcequotas/{name}
Parameter | +Description | +
---|---|
name | +name of the ResourceQuota | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 ResourceQuota |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind ResourceQuota
+GET /api/v1/namespaces/{namespace}/resourcequotas
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ResourceQuotaList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind ResourceQuota
+GET /api/v1/resourcequotas
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ResourceQuotaList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind ResourceQuota
+GET /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}
Parameter | +Description | +
---|---|
name | +name of the ResourceQuota | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of ResourceQuota
+GET /api/v1/watch/namespaces/{namespace}/resourcequotas
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of ResourceQuota
+GET /api/v1/watch/resourcequotas
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update status of the specified ResourceQuota
+PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
Parameter | +Description | +
---|---|
name | +name of the ResourceQuota | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 ResourceQuota |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read status of the specified ResourceQuota
+GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
Parameter | +Description | +
---|---|
name | +name of the ResourceQuota | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 ResourceQuota |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified ResourceQuota
+PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
Parameter | +Description | +
---|---|
name | +name of the ResourceQuota | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ResourceQuota |
++ |
Code | +Description | +
---|---|
200 ResourceQuota |
+OK | +
Group | +Version | +Kind | +
---|---|---|
rbac | +v1 | +Role | +
Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. | +
rules PolicyRule array |
+Rules holds all the PolicyRules for this Role | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items Role array |
+Items is a list of Roles | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard object's metadata. | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a Role
+POST /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Role |
++ |
Code | +Description | +
---|---|
200 Role |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified Role
+PATCH /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}
Parameter | +Description | +
---|---|
name | +name of the Role | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 Role |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified Role
+PUT /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}
Parameter | +Description | +
---|---|
name | +name of the Role | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Role |
++ |
Code | +Description | +
---|---|
200 Role |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a Role
+DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}
Parameter | +Description | +
---|---|
name | +name of the Role | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of Role
+DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified Role
+GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}
Parameter | +Description | +
---|---|
name | +name of the Role | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 Role |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind Role
+GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 RoleList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind Role
+GET /apis/rbac.authorization.k8s.io/v1/roles
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 RoleList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind Role
+GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles/{name}
Parameter | +Description | +
---|---|
name | +name of the Role | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Role
+GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Role
+GET /apis/rbac.authorization.k8s.io/v1/watch/roles
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
rbac | +v1 | +RoleBinding | +
RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. | +
roleRef RoleRef |
+RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. | +
subjects Subject array |
+Subjects holds references to the objects the role applies to. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items RoleBinding array |
+Items is a list of RoleBindings | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard object's metadata. | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a RoleBinding
+POST /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body RoleBinding |
++ |
Code | +Description | +
---|---|
200 RoleBinding |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified RoleBinding
+PATCH /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the RoleBinding | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 RoleBinding |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified RoleBinding
+PUT /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the RoleBinding | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body RoleBinding |
++ |
Code | +Description | +
---|---|
200 RoleBinding |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a RoleBinding
+DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the RoleBinding | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of RoleBinding
+DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the RoleBinding | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 RoleBinding |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 RoleBindingList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1/rolebindings
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 RoleBindingList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/rolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the RoleBinding | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/rolebindings
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1/watch/rolebindings
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
authorization | +v1 | +SelfSubjectAccessReview | +
SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action
+Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
++ |
spec SelfSubjectAccessReviewSpec |
+Spec holds information about the request being evaluated. user and groups must be empty | +
status SubjectAccessReviewStatus |
+Status is filled in by the server and indicates whether the request is allowed or not | +
Field | +Description | +
---|---|
nonResourceAttributes NonResourceAttributes |
+NonResourceAttributes describes information for a non-resource access request | +
resourceAttributes ResourceAttributes |
+ResourceAuthorizationAttributes describes information for a resource access request | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a SelfSubjectAccessReview
+POST /apis/authorization.k8s.io/v1/selfsubjectaccessreviews
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body SelfSubjectAccessReview |
++ |
Code | +Description | +
---|---|
200 SelfSubjectAccessReview |
+OK | +
Group | +Version | +Kind | +
---|---|---|
authorization | +v1 | +SelfSubjectRulesReview | +
SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server.
+Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
++ |
spec SelfSubjectRulesReviewSpec |
+Spec holds information about the request being evaluated. | +
status SubjectRulesReviewStatus |
+Status is filled in by the server and indicates the set of actions a user can perform. | +
Field | +Description | +
---|---|
namespace string |
+Namespace to evaluate rules for. Required. | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a SelfSubjectRulesReview
+POST /apis/authorization.k8s.io/v1/selfsubjectrulesreviews
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body SelfSubjectRulesReview |
++ |
Code | +Description | +
---|---|
200 SelfSubjectRulesReview |
+OK | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ServiceAccount | +
ServiceAccount binds together: a name, understood by users, and perhaps by peripheral systems, for an identity a principal that can be authenticated and authorized * a set of secrets
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
automountServiceAccountToken boolean |
+AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level. | +
imagePullSecrets LocalObjectReference array |
+ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
secrets ObjectReference array patch type: merge patch merge key: name |
+Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: https://kubernetes.io/docs/concepts/configuration/secret | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items ServiceAccount array |
+List of ServiceAccounts. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a ServiceAccount
+POST /api/v1/namespaces/{namespace}/serviceaccounts
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ServiceAccount |
++ |
Code | +Description | +
---|---|
200 ServiceAccount |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified ServiceAccount
+PATCH /api/v1/namespaces/{namespace}/serviceaccounts/{name}
Parameter | +Description | +
---|---|
name | +name of the ServiceAccount | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 ServiceAccount |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified ServiceAccount
+PUT /api/v1/namespaces/{namespace}/serviceaccounts/{name}
Parameter | +Description | +
---|---|
name | +name of the ServiceAccount | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ServiceAccount |
++ |
Code | +Description | +
---|---|
200 ServiceAccount |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a ServiceAccount
+DELETE /api/v1/namespaces/{namespace}/serviceaccounts/{name}
Parameter | +Description | +
---|---|
name | +name of the ServiceAccount | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of ServiceAccount
+DELETE /api/v1/namespaces/{namespace}/serviceaccounts
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified ServiceAccount
+GET /api/v1/namespaces/{namespace}/serviceaccounts/{name}
Parameter | +Description | +
---|---|
name | +name of the ServiceAccount | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 ServiceAccount |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind ServiceAccount
+GET /api/v1/namespaces/{namespace}/serviceaccounts
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ServiceAccountList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind ServiceAccount
+GET /api/v1/serviceaccounts
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ServiceAccountList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind ServiceAccount
+GET /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}
Parameter | +Description | +
---|---|
name | +name of the ServiceAccount | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of ServiceAccount
+GET /api/v1/watch/namespaces/{namespace}/serviceaccounts
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of ServiceAccount
+GET /api/v1/watch/serviceaccounts
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
authorization | +v1 | +SubjectAccessReview | +
SubjectAccessReview checks whether or not a user or group can perform an action.
+Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
++ |
spec SubjectAccessReviewSpec |
+Spec holds information about the request being evaluated | +
status SubjectAccessReviewStatus |
+Status is filled in by the server and indicates whether the request is allowed or not | +
Field | +Description | +
---|---|
extra object |
+Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here. | +
groups string array |
+Groups is the groups you're testing for. | +
nonResourceAttributes NonResourceAttributes |
+NonResourceAttributes describes information for a non-resource access request | +
resourceAttributes ResourceAttributes |
+ResourceAuthorizationAttributes describes information for a resource access request | +
uid string |
+UID information about the requesting user. | +
user string |
+User is the user you're testing for. If you specify "User" but not "Groups", then is it interpreted as "What if User were not a member of any groups | +
Field | +Description | +
---|---|
allowed boolean |
+Allowed is required. True if the action would be allowed, false otherwise. | +
evaluationError string |
+EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request. | +
reason string |
+Reason is optional. It indicates why a request was allowed or denied. | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a SubjectAccessReview
+POST /apis/authorization.k8s.io/v1/subjectaccessreviews
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body SubjectAccessReview |
++ |
Code | +Description | +
---|---|
200 SubjectAccessReview |
+OK | +
Group | +Version | +Kind | +
---|---|---|
authentication | +v1 | +TokenReview | +
TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver.
+Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
++ |
spec TokenReviewSpec |
+Spec holds information about the request being evaluated | +
status TokenReviewStatus |
+Status is filled in by the server and indicates whether the request can be authenticated. | +
Field | +Description | +
---|---|
token string |
+Token is the opaque bearer token. | +
Field | +Description | +
---|---|
authenticated boolean |
+Authenticated indicates that the token was associated with a known user. | +
error string |
+Error indicates that the token couldn't be checked | +
user UserInfo |
+User is the UserInfo associated with the provided token. | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a TokenReview
+POST /apis/authentication.k8s.io/v1/tokenreviews
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body TokenReview |
++ |
Code | +Description | +
---|---|
200 TokenReview |
+OK | +
Group | +Version | +Kind | +
---|---|---|
networking | +v1 | +NetworkPolicy | +
NetworkPolicy describes what network traffic is allowed for a set of Pods
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec NetworkPolicySpec |
+Specification of the desired behavior for this NetworkPolicy. | +
Field | +Description | +
---|---|
egress NetworkPolicyEgressRule array |
+List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8 | +
ingress NetworkPolicyIngressRule array |
+List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default) | +
podSelector LabelSelector |
+Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace. | +
policyTypes string array |
+List of rule types that the NetworkPolicy relates to. Valid options are Ingress, Egress, or Ingress,Egress. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an Egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8 | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items NetworkPolicy array |
+Items is a list of schema objects. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a NetworkPolicy
+POST /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body NetworkPolicy |
++ |
Code | +Description | +
---|---|
200 NetworkPolicy |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified NetworkPolicy
+PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
Parameter | +Description | +
---|---|
name | +name of the NetworkPolicy | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 NetworkPolicy |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified NetworkPolicy
+PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
Parameter | +Description | +
---|---|
name | +name of the NetworkPolicy | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body NetworkPolicy |
++ |
Code | +Description | +
---|---|
200 NetworkPolicy |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a NetworkPolicy
+DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
Parameter | +Description | +
---|---|
name | +name of the NetworkPolicy | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of NetworkPolicy
+DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified NetworkPolicy
+GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
Parameter | +Description | +
---|---|
name | +name of the NetworkPolicy | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 NetworkPolicy |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind NetworkPolicy
+GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 NetworkPolicyList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind NetworkPolicy
+GET /apis/networking.k8s.io/v1/networkpolicies
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 NetworkPolicyList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind NetworkPolicy
+GET /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/networkpolicies/{name}
Parameter | +Description | +
---|---|
name | +name of the NetworkPolicy | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of NetworkPolicy
+GET /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/networkpolicies
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of NetworkPolicy
+GET /apis/networking.k8s.io/v1/watch/networkpolicies
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
This section contains definitions for objects used in the Kubernetes APIs.
+Group | +Version | +Kind | +
---|---|---|
meta | +v1 | +APIGroup | +
APIGroup contains the name, the supported versions, and the preferred version of a group.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
name string |
+name is the name of the group. | +
preferredVersion GroupVersionForDiscovery |
+preferredVersion is the version preferred by the API server, which probably is the storage version. | +
serverAddressByClientCIDRs ServerAddressByClientCIDR array |
+a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP. | +
versions GroupVersionForDiscovery array |
+versions are the versions supported in this group. | +
Group | +Version | +Kind | +
---|---|---|
meta | +v1 | +APIResource | +
APIResource specifies the name of a resource and whether it is namespaced.
+ + +Field | +Description | +
---|---|
categories string array |
+categories is a list of the grouped resources this resource belongs to (e.g. 'all') | +
group string |
+group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale". | +
kind string |
+kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo') | +
name string |
+name is the plural name of the resource. | +
namespaced boolean |
+namespaced indicates if a resource is namespaced or not. | +
shortNames string array |
+shortNames is a list of suggested short names of the resource. | +
singularName string |
+singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface. | +
verbs string array |
+verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy) | +
version string |
+version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)". | +
Group | +Version | +Kind | +
---|---|---|
apiregistration | +v1beta1 | +APIServiceCondition | +
Field | +Description | +
---|---|
lastTransitionTime Time |
+Last time the condition transitioned from one status to another. | +
message string |
+Human-readable message indicating details about last transition. | +
reason string |
+Unique, one-word, CamelCase reason for the condition's last transition. | +
status string |
+Status is the status of the condition. Can be True, False, Unknown. | +
type string |
+Type is the type of the condition. | +
Group | +Version | +Kind | +
---|---|---|
meta | +v1 | +APIVersions | +
APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API.
+Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
serverAddressByClientCIDRs ServerAddressByClientCIDR array |
+a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP. | +
versions string array |
+versions are the api versions that are available. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +AWSElasticBlockStoreVolumeSource | +
Represents a Persistent Disk resource in AWS.
+An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.
+ + +Field | +Description | +
---|---|
fsType string |
+Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore | +
partition integer |
+The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). | +
readOnly boolean |
+Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore | +
volumeID string |
+Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore | +
Group | +Version | +Kind | +
---|---|---|
admissionregistration | +v1alpha1 | +AdmissionHookClientConfig | +
AdmissionHookClientConfig contains the information to make a TLS connection with the webhook
+ + +Field | +Description | +
---|---|
caBundle string |
+CABundle is a PEM encoded CA bundle which will be used to validate webhook's server certificate. Required | +
service ServiceReference |
+Service is a reference to the service for this webhook. If there is only one port open for the service, that port will be used. If there are multiple ports open, port 443 will be used if it is open, otherwise it is an error. Required | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +Affinity | +
Affinity is a group of affinity scheduling rules.
+ + +Field | +Description | +
---|---|
nodeAffinity NodeAffinity |
+Describes node affinity scheduling rules for the pod. | +
podAffinity PodAffinity |
+Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). | +
podAntiAffinity PodAntiAffinity |
+Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +AllowedHostPath | +
defines the host volume conditions that will be enabled by a policy for pods to use. It requires the path prefix to be defined.
+ + +Field | +Description | +
---|---|
pathPrefix string |
+is the path prefix that the host volume must match. It does not support * . Trailing slashes are trimmed when validating the path prefix with a host path. Examples: /foo would allow /foo , /foo/ and /foo/bar /foo would not allow /food or /etc/foo |
+
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +AttachedVolume | +
AttachedVolume describes a volume attached to a node
+ + +Field | +Description | +
---|---|
devicePath string |
+DevicePath represents the device path where the volume should be available | +
name string |
+Name of the attached volume | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +AzureDiskVolumeSource | +
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
+ + +Field | +Description | +
---|---|
cachingMode string |
+Host Caching mode: None, Read Only, Read Write. | +
diskName string |
+The Name of the data disk in the blob storage | +
diskURI string |
+The URI the data disk in the blob storage | +
fsType string |
+Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. | +
kind string |
+Expected values Shared: mulitple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared | +
readOnly boolean |
+Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +AzureFilePersistentVolumeSource | +
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
+ + +Field | +Description | +
---|---|
readOnly boolean |
+Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | +
secretName string |
+the name of secret that contains Azure Storage Account Name and Key | +
secretNamespace string |
+the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod | +
shareName string |
+Share Name | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +AzureFileVolumeSource | +
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
+ + +Field | +Description | +
---|---|
readOnly boolean |
+Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | +
secretName string |
+the name of secret that contains Azure Storage Account Name and Key | +
shareName string |
+Share Name | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +Capabilities | +
Adds and removes POSIX capabilities from running containers.
+ + +Field | +Description | +
---|---|
add string array |
+Added capabilities | +
drop string array |
+Removed capabilities | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +CephFSPersistentVolumeSource | +
Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.
+ + +Field | +Description | +
---|---|
monitors string array |
+Required: Monitors is a collection of Ceph monitors More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it | +
path string |
+Optional: Used as the mounted root, rather than the full Ceph tree, default is / | +
readOnly boolean |
+Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it | +
secretFile string |
+Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it | +
secretRef SecretReference |
+Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it | +
user string |
+Optional: User is the rados user name, default is admin More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +CephFSVolumeSource | +
Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.
+ + +Field | +Description | +
---|---|
monitors string array |
+Required: Monitors is a collection of Ceph monitors More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it | +
path string |
+Optional: Used as the mounted root, rather than the full Ceph tree, default is / | +
readOnly boolean |
+Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it | +
secretFile string |
+Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it | +
secretRef LocalObjectReference |
+Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it | +
user string |
+Optional: User is the rados user name, default is admin More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it | +
Group | +Version | +Kind | +
---|---|---|
certificates | +v1beta1 | +CertificateSigningRequestCondition | +
Field | +Description | +
---|---|
lastUpdateTime Time |
+timestamp for the last update to this condition | +
message string |
+human readable message with details about the request state | +
reason string |
+brief reason for the request state | +
type string |
+request approval state, currently Approved or Denied. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +CinderVolumeSource | +
Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.
+ + +Field | +Description | +
---|---|
fsType string |
+Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md | +
readOnly boolean |
+Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md | +
volumeID string |
+volume id used to identify the volume in cinder More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ClientIPConfig | +
ClientIPConfig represents the configurations of Client IP based session affinity.
+ + +Field | +Description | +
---|---|
timeoutSeconds integer |
+timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours). | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ComponentCondition | +
Information about the condition of a component.
+ + +Field | +Description | +
---|---|
error string |
+Condition error code for a component. For example, a health check error code. | +
message string |
+Message about the condition for a component. For example, information about a health check. | +
status string |
+Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown". | +
type string |
+Type of condition for a component. Valid value: "Healthy" | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ConfigMapEnvSource | +
ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.
+The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.
+ + +Field | +Description | +
---|---|
name string |
+Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | +
optional boolean |
+Specify whether the ConfigMap must be defined | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ConfigMapKeySelector | +
Selects a key from a ConfigMap.
+ + +Field | +Description | +
---|---|
key string |
+The key to select. | +
name string |
+Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | +
optional boolean |
+Specify whether the ConfigMap or it's key must be defined | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ConfigMapProjection | +
Adapts a ConfigMap into a projected volume.
+The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.
+ + +Field | +Description | +
---|---|
items KeyToPath array |
+If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. | +
name string |
+Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | +
optional boolean |
+Specify whether the ConfigMap or it's keys must be defined | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ConfigMapVolumeSource | +
Adapts a ConfigMap into a volume.
+The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.
+ + +Field | +Description | +
---|---|
defaultMode integer |
+Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | +
items KeyToPath array |
+If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. | +
name string |
+Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | +
optional boolean |
+Specify whether the ConfigMap or it's keys must be defined | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ContainerImage | +
Describe a container image
+ + +Field | +Description | +
---|---|
names string array |
+Names by which this image is known. e.g. ["gcr.io/google_containers/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"] | +
sizeBytes integer |
+The size of the image in bytes. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ContainerPort | +
ContainerPort represents a network port in a single container.
+ + +Field | +Description | +
---|---|
containerPort integer |
+Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. | +
hostIP string |
+What host IP to bind the external port to. | +
hostPort integer |
+Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. | +
name string |
+If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. | +
protocol string |
+Protocol for port. Must be UDP or TCP. Defaults to "TCP". | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ContainerState | +
ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.
+ + +Field | +Description | +
---|---|
running ContainerStateRunning |
+Details about a running container | +
terminated ContainerStateTerminated |
+Details about a terminated container | +
waiting ContainerStateWaiting |
+Details about a waiting container | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ContainerStateRunning | +
ContainerStateRunning is a running state of a container.
+ + +Field | +Description | +
---|---|
startedAt Time |
+Time at which the container was last (re-)started | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ContainerStateTerminated | +
ContainerStateTerminated is a terminated state of a container.
+ + +Field | +Description | +
---|---|
containerID string |
+Container's ID in the format 'docker:// |
+
exitCode integer |
+Exit status from the last termination of the container | +
finishedAt Time |
+Time at which the container last terminated | +
message string |
+Message regarding the last termination of the container | +
reason string |
+(brief) reason from the last termination of the container | +
signal integer |
+Signal from the last termination of the container | +
startedAt Time |
+Time at which previous execution of the container started | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ContainerStateWaiting | +
ContainerStateWaiting is a waiting state of a container.
+ + +Field | +Description | +
---|---|
message string |
+Message regarding why the container is not yet running. | +
reason string |
+(brief) reason the container is not yet running. | +
Group | +Version | +Kind | +
---|---|---|
autoscaling | +v1 | +CrossVersionObjectReference | +
CrossVersionObjectReference contains enough information to let you identify the referred resource.
+ + +Field | +Description | +
---|---|
apiVersion string |
+API version of the referent | +
kind string |
+Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds" | +
name string |
+Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names | +
Group | +Version | +Kind | +
---|---|---|
apiextensions | +v1beta1 | +CustomResourceDefinitionCondition | +
CustomResourceDefinitionCondition contains details for the current condition of this pod.
+ + +Field | +Description | +
---|---|
lastTransitionTime Time |
+Last time the condition transitioned from one status to another. | +
message string |
+Human-readable message indicating details about last transition. | +
reason string |
+Unique, one-word, CamelCase reason for the condition's last transition. | +
status string |
+Status is the status of the condition. Can be True, False, Unknown. | +
type string |
+Type is the type of the condition. | +
Group | +Version | +Kind | +
---|---|---|
apiextensions | +v1beta1 | +CustomResourceDefinitionNames | +
CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition
+ + +Field | +Description | +
---|---|
kind string |
+Kind is the serialized kind of the resource. It is normally CamelCase and singular. | +
listKind string |
+ListKind is the serialized kind of the list for this resource. Defaults to |
+
plural string |
+Plural is the plural name of the resource to serve. It must match the name of the CustomResourceDefinition-registration too: plural.group and it must be all lowercase. | +
shortNames string array |
+ShortNames are short names for the resource. It must be all lowercase. | +
singular string |
+Singular is the singular name of the resource. It must be all lowercase Defaults to lowercased |
+
Group | +Version | +Kind | +
---|---|---|
apiextensions | +v1beta1 | +CustomResourceValidation | +
CustomResourceValidation is a list of validation methods for CustomResources.
+ + +Field | +Description | +
---|---|
openAPIV3Schema JSONSchemaProps |
+OpenAPIV3Schema is the OpenAPI v3 schema to be validated against. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +DaemonEndpoint | +
DaemonEndpoint contains information about a single Daemon endpoint.
+ + +Field | +Description | +
---|---|
Port integer |
+Port number of the given endpoint. | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +DaemonSetUpdateStrategy | +
Field | +Description | +
---|---|
rollingUpdate RollingUpdateDaemonSet |
+Rolling update config params. Present only if type = "RollingUpdate". | +
type string |
+Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is OnDelete. | +
Group | +Version | +Kind | +
---|---|---|
meta | +v1 | +DeleteOptions | +
DeleteOptions may be provided when deleting an API object.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
gracePeriodSeconds integer |
+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. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
orphanDependents boolean |
+Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
preconditions Preconditions |
+Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. | +
propagationPolicy string |
+Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Group | +Version | +Kind | +
---|---|---|
apps | +v1beta1 | +DeploymentCondition | +
DeploymentCondition describes the state of a deployment at a certain point.
+ + +Field | +Description | +
---|---|
lastTransitionTime Time |
+Last time the condition transitioned from one status to another. | +
lastUpdateTime Time |
+The last time this condition was updated. | +
message string |
+A human readable message indicating details about the transition. | +
reason string |
+The reason for the condition's last transition. | +
status string |
+Status of the condition, one of True, False, Unknown. | +
type string |
+Type of deployment condition. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +DownwardAPIProjection | +
Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.
+ + +Field | +Description | +
---|---|
items DownwardAPIVolumeFile array |
+Items is a list of DownwardAPIVolume file | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +DownwardAPIVolumeFile | +
DownwardAPIVolumeFile represents information to create the file containing the pod field
+ + +Field | +Description | +
---|---|
fieldRef ObjectFieldSelector |
+Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. | +
mode integer |
+Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | +
path string |
+Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' | +
resourceFieldRef ResourceFieldSelector |
+Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +DownwardAPIVolumeSource | +
DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.
+ + +Field | +Description | +
---|---|
defaultMode integer |
+Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | +
items DownwardAPIVolumeFile array |
+Items is a list of downward API volume file | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +EmptyDirVolumeSource | +
Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.
+ + +Field | +Description | +
---|---|
medium string |
+What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir | +
sizeLimit Quantity |
+Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +EndpointAddress | +
EndpointAddress is a tuple that describes single IP address.
+ + +Field | +Description | +
---|---|
hostname string |
+The Hostname of this endpoint | +
ip string |
+The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready. | +
nodeName string |
+Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node. | +
targetRef ObjectReference |
+Reference to object providing the endpoint. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +EndpointPort | +
EndpointPort is a tuple that describes a single port.
+ + +Field | +Description | +
---|---|
name string |
+The name of this port (corresponds to ServicePort.Name). Must be a DNS_LABEL. Optional only if one port is defined. | +
port integer |
+The port number of the endpoint. | +
protocol string |
+The IP protocol for this port. Must be UDP or TCP. Default is TCP. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +EndpointSubset | +
EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given: + { + Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], + Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] + } +The resulting set of endpoints can be viewed as: + a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], + b: [ 10.10.1.1:309, 10.10.2.2:309 ]
+ + +Field | +Description | +
---|---|
addresses EndpointAddress array |
+IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize. | +
notReadyAddresses EndpointAddress array |
+IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check. | +
ports EndpointPort array |
+Port numbers available on the related IP addresses. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +EnvFromSource | +
EnvFromSource represents the source of a set of ConfigMaps
+ + +Field | +Description | +
---|---|
configMapRef ConfigMapEnvSource |
+The ConfigMap to select from | +
prefix string |
+An optional identifer to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. | +
secretRef SecretEnvSource |
+The Secret to select from | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +EnvVar | +
EnvVar represents an environment variable present in a Container.
+ + +Field | +Description | +
---|---|
name string |
+Name of the environment variable. Must be a C_IDENTIFIER. | +
value string |
+Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". | +
valueFrom EnvVarSource |
+Source for the environment variable's value. Cannot be used if value is not empty. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +EnvVarSource | +
EnvVarSource represents a source for the value of an EnvVar.
+ + +Field | +Description | +
---|---|
configMapKeyRef ConfigMapKeySelector |
+Selects a key of a ConfigMap. | +
fieldRef ObjectFieldSelector |
+Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP. | +
resourceFieldRef ResourceFieldSelector |
+Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. | +
secretKeyRef SecretKeySelector |
+Selects a key of a secret in the pod's namespace | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +EventSource | +
EventSource contains information for an event.
+ + +Field | +Description | +
---|---|
component string |
+Component from which the event is generated. | +
host string |
+Node name on which the event is generated. | +
Group | +Version | +Kind | +
---|---|---|
policy | +v1beta1 | +Eviction | +
Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to .../pods/
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
deleteOptions DeleteOptions |
+DeleteOptions may be provided | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+ObjectMeta describes the pod that is being evicted. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ExecAction | +
ExecAction describes a "run in container" action.
+ + +Field | +Description | +|
---|---|---|
command string array |
+Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions (' | +', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. | +
Group | +Version | +Kind | +
---|---|---|
admissionregistration | +v1alpha1 | +ExternalAdmissionHook | +
ExternalAdmissionHook describes an external admission webhook and the resources and operations it applies to.
+ + +Field | +Description | +
---|---|
clientConfig AdmissionHookClientConfig |
+ClientConfig defines how to communicate with the hook. Required | +
failurePolicy string |
+FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Ignore. | +
name string |
+The name of the external admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required. | +
rules RuleWithOperations array |
+Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches any Rule. | +
Group | +Version | +Kind | +
---|---|---|
apiextensions | +v1beta1 | +ExternalDocumentation | +
ExternalDocumentation allows referencing an external resource for extended documentation.
+ + +Field | +Description | +
---|---|
description string |
++ |
url string |
++ |
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +FCVolumeSource | +
Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.
+ + +Field | +Description | +
---|---|
fsType string |
+Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. | +
lun integer |
+Optional: FC target lun number | +
readOnly boolean |
+Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | +
targetWWNs string array |
+Optional: FC target worldwide names (WWNs) | +
wwids string array |
+Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +FSGroupStrategyOptions | +
FSGroupStrategyOptions defines the strategy type and options used to create the strategy.
+ + +Field | +Description | +
---|---|
ranges IDRange array |
+Ranges are the allowed ranges of fs groups. If you would like to force a single fs group then supply a single range with the same start and end. | +
rule string |
+Rule is the strategy that will dictate what FSGroup is used in the SecurityContext. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +FlexVolumeSource | +
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.
+ + +Field | +Description | +
---|---|
driver string |
+Driver is the name of the driver to use for this volume. | +
fsType string |
+Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. | +
options object |
+Optional: Extra command options if any. | +
readOnly boolean |
+Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | +
secretRef LocalObjectReference |
+Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +FlockerVolumeSource | +
Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.
+ + +Field | +Description | +
---|---|
datasetName string |
+Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated | +
datasetUUID string |
+UUID of the dataset. This is unique identifier of a Flocker dataset | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +GCEPersistentDiskVolumeSource | +
Represents a Persistent Disk resource in Google Compute Engine.
+A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.
+ + +Field | +Description | +
---|---|
fsType string |
+Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk | +
partition integer |
+The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk | +
pdName string |
+Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk | +
readOnly boolean |
+ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +GitRepoVolumeSource | +
Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.
+ + +Field | +Description | +
---|---|
directory string |
+Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. | +
repository string |
+Repository URL | +
revision string |
+Commit hash for the specified revision. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +GlusterfsVolumeSource | +
Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.
+ + +Field | +Description | +
---|---|
endpoints string |
+EndpointsName is the endpoint name that details Glusterfs topology. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod | +
path string |
+Path is the Glusterfs volume path. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod | +
readOnly boolean |
+ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod | +
Group | +Version | +Kind | +
---|---|---|
meta | +v1 | +GroupVersionForDiscovery | +
GroupVersion contains the "group/version" and "version" string of a version. It is made a struct to keep extensibility.
+ + +Field | +Description | +
---|---|
groupVersion string |
+groupVersion specifies the API group and version in the form "group/version" | +
version string |
+version specifies the version in the form of "version". This is to save the clients the trouble of splitting the GroupVersion. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +HTTPGetAction | +
HTTPGetAction describes an action based on HTTP Get requests.
+ + +Field | +Description | +
---|---|
host string |
+Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. | +
httpHeaders HTTPHeader array |
+Custom headers to set in the request. HTTP allows repeated headers. | +
path string |
+Path to access on the HTTP server. | +
port | +Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. | +
scheme string |
+Scheme to use for connecting to the host. Defaults to HTTP. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +HTTPHeader | +
HTTPHeader describes a custom header to be used in HTTP probes
+ + +Field | +Description | +
---|---|
name string |
+The header field name | +
value string |
+The header field value | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +HTTPIngressPath | +
HTTPIngressPath associates a path regex with a backend. Incoming urls matching the path are forwarded to the backend.
+ + +Field | +Description | +
---|---|
backend IngressBackend |
+Backend defines the referenced service endpoint to which the traffic will be forwarded to. | +
path string |
+Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e this follows the egrep/unix syntax, not the perl syntax) matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/'. If unspecified, the path defaults to a catch all sending traffic to the backend. | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +HTTPIngressRuleValue | +
HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://
Field | +Description | +
---|---|
paths HTTPIngressPath array |
+A collection of paths that map requests to backends. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +Handler | +
Handler defines a specific action that should be taken
+ + +Field | +Description | +
---|---|
exec ExecAction |
+One and only one of the following should be specified. Exec specifies the action to take. | +
httpGet HTTPGetAction |
+HTTPGet specifies the http request to perform. | +
tcpSocket TCPSocketAction |
+TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported | +
Group | +Version | +Kind | +
---|---|---|
autoscaling | +v2beta1 | +HorizontalPodAutoscalerCondition | +
HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point.
+ + +Field | +Description | +
---|---|
lastTransitionTime Time |
+lastTransitionTime is the last time the condition transitioned from one status to another | +
message string |
+message is a human-readable explanation containing details about the transition | +
reason string |
+reason is the reason for the condition's last transition. | +
status string |
+status is the status of the condition (True, False, Unknown) | +
type string |
+type describes the current condition | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +HostAlias | +
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.
+ + +Field | +Description | +
---|---|
hostnames string array |
+Hostnames for the above IP address. | +
ip string |
+IP address of the host file entry. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +HostPathVolumeSource | +
Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.
+ + +Field | +Description | +
---|---|
path string |
+Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath | +
type string |
+Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +HostPortRange | +
Host Port Range defines a range of host ports that will be enabled by a policy for pods to use. It requires both the start and end to be defined.
+ + +Field | +Description | +
---|---|
max integer |
+max is the end of the range, inclusive. | +
min integer |
+min is the start of the range, inclusive. | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +IDRange | +
ID Range provides a min/max of an allowed range of IDs.
+ + +Field | +Description | +
---|---|
max integer |
+Max is the end of the range, inclusive. | +
min integer |
+Min is the start of the range, inclusive. | +
Group | +Version | +Kind | +
---|---|---|
networking | +v1 | +IPBlock | +
IPBlock describes a particular CIDR (Ex. "192.168.1.1/24") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.
+ + +Field | +Description | +
---|---|
cidr string |
+CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24" | +
except string array |
+Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" Except values will be rejected if they are outside the CIDR range | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ISCSIVolumeSource | +
Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
+ + +Field | +Description | +
---|---|
chapAuthDiscovery boolean |
+whether support iSCSI Discovery CHAP authentication | +
chapAuthSession boolean |
+whether support iSCSI Session CHAP authentication | +
fsType string |
+Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi | +
initiatorName string |
+Custom iSCSI initiator name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface |
+
iqn string |
+Target iSCSI Qualified Name. | +
iscsiInterface string |
+Optional: Defaults to 'default' (tcp). iSCSI interface name that uses an iSCSI transport. | +
lun integer |
+iSCSI target lun number. | +
portals string array |
+iSCSI target portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). | +
readOnly boolean |
+ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. | +
secretRef LocalObjectReference |
+CHAP secret for iSCSI target and initiator authentication | +
targetPortal string |
+iSCSI target portal. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +IngressBackend | +
IngressBackend describes all endpoints for a given service and port.
+ + +Field | +Description | +
---|---|
serviceName string |
+Specifies the name of the referenced service. | +
servicePort | +Specifies the port of the referenced service. | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +IngressRule | +
IngressRule represents the rules mapping the paths under a specified host to the related backend services. Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue.
+ + +Field | +Description | +
---|---|
host string |
+Host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in the RFC: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the IP in the Spec of the parent Ingress. 2. The : delimiter is not respected because ports are not allowed. Currently the port of an Ingress is implicitly :80 for http and :443 for https. Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue. |
+
http HTTPIngressRuleValue |
++ |
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +IngressTLS | +
IngressTLS describes the transport layer security associated with an Ingress.
+ + +Field | +Description | +
---|---|
hosts string array |
+Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified. | +
secretName string |
+SecretName is the name of the secret used to terminate SSL traffic on 443. Field is left optional to allow SSL routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing. | +
Group | +Version | +Kind | +
---|---|---|
meta | +v1 | +Initializer | +
Initializer is information about an initializer that has not yet completed.
+ + +Field | +Description | +
---|---|
name string |
+name of the process that is responsible for initializing this object. | +
Group | +Version | +Kind | +
---|---|---|
meta | +v1 | +Initializers | +
Initializers tracks the progress of initialization.
+ + +Field | +Description | +
---|---|
pending Initializer array patch type: merge patch merge key: name |
+Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients. | +
result Status |
+If result is set with the Failure field, the object will be persisted to storage and then deleted, ensuring that other clients can observe the deletion. | +
Group | +Version | +Kind | +
---|---|---|
apiextensions | +v1beta1 | +JSON | +
JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
+ + +Field | +Description | +
---|---|
Raw string |
++ |
Group | +Version | +Kind | +
---|---|---|
apiextensions | +v1beta1 | +JSONSchemaProps | +
JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).
+ + +Field | +Description | +
---|---|
$ref string |
++ |
$schema string |
++ |
additionalItems JSONSchemaPropsOrBool |
++ |
additionalProperties JSONSchemaPropsOrBool |
++ |
allOf JSONSchemaProps array |
++ |
anyOf JSONSchemaProps array |
++ |
default JSON |
++ |
definitions object |
++ |
dependencies object |
++ |
description string |
++ |
enum JSON array |
++ |
example JSON |
++ |
exclusiveMaximum boolean |
++ |
exclusiveMinimum boolean |
++ |
externalDocs ExternalDocumentation |
++ |
format string |
++ |
id string |
++ |
items JSONSchemaPropsOrArray |
++ |
maxItems integer |
++ |
maxLength integer |
++ |
maxProperties integer |
++ |
maximum number |
++ |
minItems integer |
++ |
minLength integer |
++ |
minProperties integer |
++ |
minimum number |
++ |
multipleOf number |
++ |
not JSONSchemaProps |
++ |
oneOf JSONSchemaProps array |
++ |
pattern string |
++ |
patternProperties object |
++ |
properties object |
++ |
required string array |
++ |
title string |
++ |
type string |
++ |
uniqueItems boolean |
++ |
Group | +Version | +Kind | +
---|---|---|
apiextensions | +v1beta1 | +JSONSchemaPropsOrArray | +
JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization purposes.
+ + +Field | +Description | +
---|---|
JSONSchemas JSONSchemaProps array |
++ |
Schema JSONSchemaProps |
++ |
Group | +Version | +Kind | +
---|---|---|
apiextensions | +v1beta1 | +JSONSchemaPropsOrBool | +
JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.
+ + +Field | +Description | +
---|---|
Allows boolean |
++ |
Schema JSONSchemaProps |
++ |
Group | +Version | +Kind | +
---|---|---|
batch | +v1 | +JobCondition | +
JobCondition describes current state of a job.
+ + +Field | +Description | +
---|---|
lastProbeTime Time |
+Last time the condition was checked. | +
lastTransitionTime Time |
+Last time the condition transit from one status to another. | +
message string |
+Human readable message indicating details about last transition. | +
reason string |
+(brief) reason for the condition's last transition. | +
status string |
+Status of the condition, one of True, False, Unknown. | +
type string |
+Type of job condition, Complete or Failed. | +
Group | +Version | +Kind | +
---|---|---|
batch | +v1beta1 | +JobTemplateSpec | +
JobTemplateSpec describes the data a Job should have when created from a template
+ + +Field | +Description | +
---|---|
metadata ObjectMeta |
+Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec JobSpec |
+Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +KeyToPath | +
Maps a string key to a path within a volume.
+ + +Field | +Description | +
---|---|
key string |
+The key to project. | +
mode integer |
+Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | +
path string |
+The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. | +
Group | +Version | +Kind | +
---|---|---|
meta | +v1 | +LabelSelector | +
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
+ + +Field | +Description | +
---|---|
matchExpressions LabelSelectorRequirement array |
+matchExpressions is a list of label selector requirements. The requirements are ANDed. | +
matchLabels object |
+matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. | +
Group | +Version | +Kind | +
---|---|---|
meta | +v1 | +LabelSelectorRequirement | +
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ + +Field | +Description | +
---|---|
key string patch type: merge patch merge key: key |
+key is the label key that the selector applies to. | +
operator string |
+operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. | +
values string array |
+values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +Lifecycle | +
Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.
+ + +Field | +Description | +
---|---|
postStart Handler |
+PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks | +
preStop Handler |
+PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +LimitRangeItem | +
LimitRangeItem defines a min/max usage limit for any resource that matches on kind.
+ + +Field | +Description | +
---|---|
default object |
+Default resource requirement limit value by resource name if resource limit is omitted. | +
defaultRequest object |
+DefaultRequest is the default resource requirement request value by resource name if resource request is omitted. | +
max object |
+Max usage constraints on this kind by resource name. | +
maxLimitRequestRatio object |
+MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource. | +
min object |
+Min usage constraints on this kind by resource name. | +
type string |
+Type of resource that this limit applies to. | +
Group | +Version | +Kind | +
---|---|---|
meta | +v1 | +ListMeta | +
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
+ + +Field | +Description | +
---|---|
continue string |
+continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response. | +
resourceVersion string |
+String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency | +
selfLink string |
+selfLink is a URL representing this object. Populated by the system. Read-only. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +LoadBalancerIngress | +
LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.
+ + +Field | +Description | +
---|---|
hostname string |
+Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers) | +
ip string |
+IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers) | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +LoadBalancerStatus | +
LoadBalancerStatus represents the status of a load-balancer.
+ + +Field | +Description | +
---|---|
ingress LoadBalancerIngress array |
+Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +LocalObjectReference | +
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
+ + +Field | +Description | +
---|---|
name string |
+Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +LocalVolumeSource | +
Local represents directly-attached storage with node affinity
+ + +Field | +Description | +
---|---|
path string |
+The full path to the volume on the node For alpha, this path must be a directory Once block as a source is supported, then this path can point to a block device | +
Group | +Version | +Kind | +
---|---|---|
autoscaling | +v2beta1 | +MetricSpec | +
MetricSpec specifies how to scale based on a single metric (only type
and one other matching field should be set at once).
Field | +Description | +
---|---|
object ObjectMetricSource |
+object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). | +
pods PodsMetricSource |
+pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value. | +
resource ResourceMetricSource |
+resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. | +
type string |
+type is the type of metric source. It should match one of the fields below. | +
Group | +Version | +Kind | +
---|---|---|
autoscaling | +v2beta1 | +MetricStatus | +
MetricStatus describes the last-read state of a single metric.
+ + +Field | +Description | +
---|---|
object ObjectMetricStatus |
+object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). | +
pods PodsMetricStatus |
+pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value. | +
resource ResourceMetricStatus |
+resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. | +
type string |
+type is the type of metric source. It will match one of the fields below. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +NFSVolumeSource | +
Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.
+ + +Field | +Description | +
---|---|
path string |
+Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs | +
readOnly boolean |
+ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs | +
server string |
+Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs | +
Group | +Version | +Kind | +
---|---|---|
networking | +v1 | +NetworkPolicyEgressRule | +
NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8
+ + +Field | +Description | +
---|---|
ports NetworkPolicyPort array |
+List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list. | +
to NetworkPolicyPeer array |
+List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list. | +
Group | +Version | +Kind | +
---|---|---|
networking | +v1 | +NetworkPolicyIngressRule | +
NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.
+ + +Field | +Description | +
---|---|
from NetworkPolicyPeer array |
+List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least on item, this rule allows traffic only if the traffic matches at least one item in the from list. | +
ports NetworkPolicyPort array |
+List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list. | +
Group | +Version | +Kind | +
---|---|---|
networking | +v1 | +NetworkPolicyPeer | +
NetworkPolicyPeer describes a peer to allow traffic from. Exactly one of its fields must be specified.
+ + +Field | +Description | +
---|---|
ipBlock IPBlock |
+IPBlock defines policy on a particular IPBlock | +
namespaceSelector LabelSelector |
+Selects Namespaces using cluster scoped-labels. This matches all pods in all namespaces selected by this label selector. This field follows standard label selector semantics. If present but empty, this selector selects all namespaces. | +
podSelector LabelSelector |
+This is a label selector which selects Pods in this namespace. This field follows standard label selector semantics. If present but empty, this selector selects all pods in this namespace. | +
Group | +Version | +Kind | +
---|---|---|
networking | +v1 | +NetworkPolicyPort | +
NetworkPolicyPort describes a port to allow traffic on
+ + +Field | +Description | +
---|---|
port | +The port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. | +
protocol string |
+The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +NodeAddress | +
NodeAddress contains information for the node's address.
+ + +Field | +Description | +
---|---|
address string |
+The node address. | +
type string |
+Node address type, one of Hostname, ExternalIP or InternalIP. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +NodeAffinity | +
Node affinity is a group of node affinity scheduling rules.
+ + +Field | +Description | +
---|---|
preferredDuringSchedulingIgnoredDuringExecution PreferredSchedulingTerm array |
+The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. | +
requiredDuringSchedulingIgnoredDuringExecution NodeSelector |
+If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +NodeCondition | +
NodeCondition contains condition information for a node.
+ + +Field | +Description | +
---|---|
lastHeartbeatTime Time |
+Last time we got an update on a given condition. | +
lastTransitionTime Time |
+Last time the condition transit from one status to another. | +
message string |
+Human readable message indicating details about last transition. | +
reason string |
+(brief) reason for the condition's last transition. | +
status string |
+Status of the condition, one of True, False, Unknown. | +
type string |
+Type of node condition. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +NodeConfigSource | +
NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
configMapRef ObjectReference |
++ |
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +NodeDaemonEndpoints | +
NodeDaemonEndpoints lists ports opened by daemons running on the Node.
+ + +Field | +Description | +
---|---|
kubeletEndpoint DaemonEndpoint |
+Endpoint on which Kubelet is listening. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +NodeSelector | +
A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.
+ + +Field | +Description | +
---|---|
nodeSelectorTerms NodeSelectorTerm array |
+Required. A list of node selector terms. The terms are ORed. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +NodeSelectorRequirement | +
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ + +Field | +Description | +
---|---|
key string |
+The label key that the selector applies to. | +
operator string |
+Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. | +
values string array |
+An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +NodeSelectorTerm | +
A null or empty node selector term matches no objects.
+ + +Field | +Description | +
---|---|
matchExpressions NodeSelectorRequirement array |
+Required. A list of node selector requirements. The requirements are ANDed. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +NodeSystemInfo | +
NodeSystemInfo is a set of ids/uuids to uniquely identify the node.
+ + +Field | +Description | +
---|---|
architecture string |
+The Architecture reported by the node | +
bootID string |
+Boot ID reported by the node. | +
containerRuntimeVersion string |
+ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0). | +
kernelVersion string |
+Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64). | +
kubeProxyVersion string |
+KubeProxy Version reported by the node. | +
kubeletVersion string |
+Kubelet Version reported by the node. | +
machineID string |
+MachineID reported by the node. For unique machine identification in the cluster this field is preferred. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html | +
operatingSystem string |
+The Operating System reported by the node | +
osImage string |
+OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)). | +
systemUUID string |
+SystemUUID reported by the node. For unique machine identification MachineID is preferred. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-US/Red_Hat_Subscription_Management/1/html/RHSM/getting-system-uuid.html | +
Group | +Version | +Kind | +
---|---|---|
authorization | +v1 | +NonResourceAttributes | +
NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface
+ + +Field | +Description | +
---|---|
path string |
+Path is the URL path of the request | +
verb string |
+Verb is the standard HTTP verb | +
Group | +Version | +Kind | +
---|---|---|
authorization | +v1 | +NonResourceRule | +
NonResourceRule holds information that describes a rule for the non-resource
+ + +Field | +Description | +
---|---|
nonResourceURLs string array |
+NonResourceURLs is a set of partial urls that a user should have access to. s are allowed, but only as the full, final step in the path. "" means all. | +
verbs string array |
+Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ObjectFieldSelector | +
ObjectFieldSelector selects an APIVersioned field of an object.
+ + +Field | +Description | +
---|---|
apiVersion string |
+Version of the schema the FieldPath is written in terms of, defaults to "v1". | +
fieldPath string |
+Path of the field to select in the specified API version. | +
Group | +Version | +Kind | +
---|---|---|
meta | +v1 | +ObjectMeta | +
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
+ + +Field | +Description | +
---|---|
annotations object |
+Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations | +
clusterName string |
+The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. | +
creationTimestamp Time |
+CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
deletionGracePeriodSeconds integer |
+Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. | +
deletionTimestamp Time |
+DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
finalizers string array patch type: merge |
+Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. | +
generateName string |
+GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency | +
generation integer |
+A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. | +
initializers Initializers |
+An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects. When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user. | +
labels object |
+Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels | +
name string |
+Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names | +
namespace string |
+Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces | +
ownerReferences OwnerReference array patch type: merge patch merge key: uid |
+List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. | +
resourceVersion string |
+An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency | +
selfLink string |
+SelfLink is a URL representing this object. Populated by the system. Read-only. | +
uid string |
+UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | +
Group | +Version | +Kind | +
---|---|---|
autoscaling | +v2beta1 | +ObjectMetricSource | +
ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).
+ + +Field | +Description | +
---|---|
metricName string |
+metricName is the name of the metric in question. | +
target CrossVersionObjectReference |
+target is the described Kubernetes object. | +
targetValue Quantity |
+targetValue is the target value of the metric (as a quantity). | +
Group | +Version | +Kind | +
---|---|---|
autoscaling | +v2beta1 | +ObjectMetricStatus | +
ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).
+ + +Field | +Description | +
---|---|
currentValue Quantity |
+currentValue is the current value of the metric (as a quantity). | +
metricName string |
+metricName is the name of the metric in question. | +
target CrossVersionObjectReference |
+target is the described Kubernetes object. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ObjectReference | +
ObjectReference contains enough information to let you inspect or modify the referred object.
+ + +Field | +Description | +
---|---|
apiVersion string |
+API version of the referent. | +
fieldPath string |
+If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. | +
kind string |
+Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
name string |
+Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | +
namespace string |
+Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | +
resourceVersion string |
+Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency | +
uid string |
+UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids | +
Group | +Version | +Kind | +
---|---|---|
meta | +v1 | +OwnerReference | +
OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.
+ + +Field | +Description | +
---|---|
apiVersion string |
+API version of the referent. | +
blockOwnerDeletion boolean |
+If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. | +
controller boolean |
+If true, this reference points to the managing controller. | +
kind string |
+Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
name string |
+Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names | +
uid string |
+UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | +
Group | +Version | +Kind | +
---|---|---|
meta | +v1 | +Patch | +
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
+Field | +Description | +
---|---|
+ |
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +PersistentVolumeClaimCondition | +
PersistentVolumeClaimCondition contails details about state of pvc
+ + +Field | +Description | +
---|---|
lastProbeTime Time |
+Last time we probed the condition. | +
lastTransitionTime Time |
+Last time the condition transitioned from one status to another. | +
message string |
+Human-readable message indicating details about last transition. | +
reason string |
+Unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized. | +
status string |
++ |
type string |
++ |
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +PersistentVolumeClaimVolumeSource | +
PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).
+ + +Field | +Description | +
---|---|
claimName string |
+ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims | +
readOnly boolean |
+Will force the ReadOnly setting in VolumeMounts. Default false. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +PhotonPersistentDiskVolumeSource | +
Represents a Photon Controller persistent disk resource.
+ + +Field | +Description | +
---|---|
fsType string |
+Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. | +
pdID string |
+ID that identifies Photon Controller persistent disk | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +PodAffinity | +
Pod affinity is a group of inter pod affinity scheduling rules.
+ + +Field | +Description | +
---|---|
preferredDuringSchedulingIgnoredDuringExecution WeightedPodAffinityTerm array |
+The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. | +
requiredDuringSchedulingIgnoredDuringExecution PodAffinityTerm array |
+If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +PodAffinityTerm | +
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key
Field | +Description | +
---|---|
labelSelector LabelSelector |
+A label query over a set of resources, in this case pods. | +
namespaces string array |
+namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace" | +
topologyKey string |
+This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. For PreferredDuringScheduling pod anti-affinity, empty topologyKey is interpreted as "all topologies" ("all topologies" here means all the topologyKeys indicated by scheduler command-line argument --failure-domains); for affinity and for RequiredDuringScheduling pod anti-affinity, empty topologyKey is not allowed. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +PodAntiAffinity | +
Pod anti affinity is a group of inter pod anti affinity scheduling rules.
+ + +Field | +Description | +
---|---|
preferredDuringSchedulingIgnoredDuringExecution WeightedPodAffinityTerm array |
+The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. | +
requiredDuringSchedulingIgnoredDuringExecution PodAffinityTerm array |
+If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +PodCondition | +
PodCondition contains details for the current condition of this pod.
+ + +Field | +Description | +
---|---|
lastProbeTime Time |
+Last time we probed the condition. | +
lastTransitionTime Time |
+Last time the condition transitioned from one status to another. | +
message string |
+Human-readable message indicating details about last transition. | +
reason string |
+Unique, one-word, CamelCase reason for the condition's last transition. | +
status string |
+Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions | +
type string |
+Type is the type of the condition. Currently only Ready. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +PodSecurityContext | +
PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.
+ + +Field | +Description | +
---|---|
fsGroup integer |
+A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume. | +
runAsNonRoot boolean |
+Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. | +
runAsUser integer |
+The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. | +
seLinuxOptions SELinuxOptions |
+The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. | +
supplementalGroups integer array |
+A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. | +
Group | +Version | +Kind | +
---|---|---|
autoscaling | +v2beta1 | +PodsMetricSource | +
PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
+ + +Field | +Description | +
---|---|
metricName string |
+metricName is the name of the metric in question | +
targetAverageValue Quantity |
+targetAverageValue is the target value of the average of the metric across all relevant pods (as a quantity) | +
Group | +Version | +Kind | +
---|---|---|
autoscaling | +v2beta1 | +PodsMetricStatus | +
PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second).
+ + +Field | +Description | +
---|---|
currentAverageValue Quantity |
+currentAverageValue is the current value of the average of the metric across all relevant pods (as a quantity) | +
metricName string |
+metricName is the name of the metric in question | +
Group | +Version | +Kind | +
---|---|---|
rbac | +v1 | +PolicyRule | +
PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.
+ + +Field | +Description | +
---|---|
apiGroups string array |
+APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. | +
nonResourceURLs string array |
+NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both. | +
resourceNames string array |
+ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. | +
resources string array |
+Resources is a list of resources this rule applies to. ResourceAll represents all resources. | +
verbs string array |
+Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +PortworxVolumeSource | +
PortworxVolumeSource represents a Portworx volume resource.
+ + +Field | +Description | +
---|---|
fsType string |
+FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. | +
readOnly boolean |
+Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | +
volumeID string |
+VolumeID uniquely identifies a Portworx volume | +
Group | +Version | +Kind | +
---|---|---|
meta | +v1 | +Preconditions | +
Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
+ + +Field | +Description | +
---|---|
uid string |
+Specifies the target UID. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +PreferredSchedulingTerm | +
An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
+ + +Field | +Description | +
---|---|
preference NodeSelectorTerm |
+A node selector term, associated with the corresponding weight. | +
weight integer |
+Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +Probe | +
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
+ + +Field | +Description | +
---|---|
exec ExecAction |
+One and only one of the following should be specified. Exec specifies the action to take. | +
failureThreshold integer |
+Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. | +
httpGet HTTPGetAction |
+HTTPGet specifies the http request to perform. | +
initialDelaySeconds integer |
+Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes | +
periodSeconds integer |
+How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. | +
successThreshold integer |
+Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. | +
tcpSocket TCPSocketAction |
+TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported | +
timeoutSeconds integer |
+Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ProjectedVolumeSource | +
Represents a projected volume source
+ + +Field | +Description | +
---|---|
defaultMode integer |
+Mode bits to use on created files by default. Must be a value between 0 and 0777. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | +
sources VolumeProjection array |
+list of volume projections | +
Group | +Version | +Kind | +
---|---|---|
Core | +resource | +Quantity | +
Field | +Description | +
---|---|
+ |
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +QuobyteVolumeSource | +
Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.
+ + +Field | +Description | +
---|---|
group string |
+Group to map volume access to Default is no group | +
readOnly boolean |
+ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. | +
registry string |
+Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes | +
user string |
+User to map volume access to Defaults to serivceaccount user | +
volume string |
+Volume is a string that references an already created Quobyte volume by name. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +RBDVolumeSource | +
Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.
+ + +Field | +Description | +
---|---|
fsType string |
+Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd | +
image string |
+The rados image name. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it | +
keyring string |
+Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it | +
monitors string array |
+A collection of Ceph monitors. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it | +
pool string |
+The rados pool name. Default is rbd. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it | +
readOnly boolean |
+ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it | +
secretRef LocalObjectReference |
+SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it | +
user string |
+The rados user name. Default is admin. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +ReplicaSetCondition | +
ReplicaSetCondition describes the state of a replica set at a certain point.
+ + +Field | +Description | +
---|---|
lastTransitionTime Time |
+The last time the condition transitioned from one status to another. | +
message string |
+A human readable message indicating details about the transition. | +
reason string |
+The reason for the condition's last transition. | +
status string |
+Status of the condition, one of True, False, Unknown. | +
type string |
+Type of replica set condition. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ReplicationControllerCondition | +
ReplicationControllerCondition describes the state of a replication controller at a certain point.
+ + +Field | +Description | +
---|---|
lastTransitionTime Time |
+The last time the condition transitioned from one status to another. | +
message string |
+A human readable message indicating details about the transition. | +
reason string |
+The reason for the condition's last transition. | +
status string |
+Status of the condition, one of True, False, Unknown. | +
type string |
+Type of replication controller condition. | +
Group | +Version | +Kind | +
---|---|---|
authorization | +v1 | +ResourceAttributes | +
ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface
+ + +Field | +Description | +
---|---|
group string |
+Group is the API Group of the Resource. "*" means all. | +
name string |
+Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all. | +
namespace string |
+Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview | +
resource string |
+Resource is one of the existing resource types. "*" means all. | +
subresource string |
+Subresource is one of the existing resource types. "" means none. | +
verb string |
+Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. | +
version string |
+Version is the API Version of the Resource. "*" means all. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ResourceFieldSelector | +
ResourceFieldSelector represents container resources (cpu, memory) and their output format
+ + +Field | +Description | +
---|---|
containerName string |
+Container name: required for volumes, optional for env vars | +
divisor Quantity |
+Specifies the output format of the exposed resources, defaults to "1" | +
resource string |
+Required: resource to select | +
Group | +Version | +Kind | +
---|---|---|
autoscaling | +v2beta1 | +ResourceMetricSource | +
ResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set.
+ + +Field | +Description | +
---|---|
name string |
+name is the name of the resource in question. | +
targetAverageUtilization integer |
+targetAverageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. | +
targetAverageValue Quantity |
+targetAverageValue is the target value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. | +
Group | +Version | +Kind | +
---|---|---|
autoscaling | +v2beta1 | +ResourceMetricStatus | +
ResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
+ + +Field | +Description | +
---|---|
currentAverageUtilization integer |
+currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. It will only be present if targetAverageValue was set in the corresponding metric specification. |
+
currentAverageValue Quantity |
+currentAverageValue is the current value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. It will always be set, regardless of the corresponding metric specification. | +
name string |
+name is the name of the resource in question. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ResourceRequirements | +
ResourceRequirements describes the compute resource requirements.
+ + +Field | +Description | +
---|---|
limits object |
+Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ | +
requests object |
+Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ | +
Group | +Version | +Kind | +
---|---|---|
authorization | +v1 | +ResourceRule | +
ResourceRule is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
+ + +Field | +Description | +
---|---|
apiGroups string array |
+APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "*" means all. | +
resourceNames string array |
+ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. "*" means all. | +
resources string array |
+Resources is a list of resources this rule applies to. ResourceAll represents all resources. "*" means all. | +
verbs string array |
+Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all. | +
Group | +Version | +Kind | +
---|---|---|
rbac | +v1 | +RoleRef | +
RoleRef contains information that points to the role being used
+ + +Field | +Description | +
---|---|
apiGroup string |
+APIGroup is the group for the resource being referenced | +
kind string |
+Kind is the type of resource being referenced | +
name string |
+Name is the name of resource being referenced | +
Group | +Version | +Kind | +
---|---|---|
apps | +v1beta1 | +RollbackConfig | +
DEPRECATED.
+ + +Field | +Description | +
---|---|
revision integer |
+The revision to rollback to. If set to 0, rollback to the last revision. | +
Group | +Version | +Kind | +
---|---|---|
apps | +v1beta1 | +RollingUpdateStatefulSetStrategy | +
RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.
+ + +Field | +Description | +
---|---|
partition integer |
+Partition indicates the ordinal at which the StatefulSet should be partitioned. | +
Group | +Version | +Kind | +
---|---|---|
admissionregistration | +v1alpha1 | +Rule | +
Rule is a tuple of APIGroups, APIVersion, and Resources.It is recommended to make sure that all the tuple expansions are valid.
+ + +Field | +Description | +
---|---|
apiGroups string array |
+APIGroups is the API groups the resources belong to. '' is all groups. If '' is present, the length of the slice must be one. Required. | +
apiVersions string array |
+APIVersions is the API versions the resources belong to. '' is all versions. If '' is present, the length of the slice must be one. Required. | +
resources string array |
+Resources is a list of resources this rule applies to. For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '' means all resources, but not subresources. 'pods/' means all subresources of pods. '/scale' means all scale subresources. '/*' means all resources and their subresources. If wildcard is present, the validation rule will ensure resources do not overlap with each other. Depending on the enclosing object, subresources might not be allowed. Required. | +
Group | +Version | +Kind | +
---|---|---|
admissionregistration | +v1alpha1 | +RuleWithOperations | +
RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid.
+ + +Field | +Description | +
---|---|
apiGroups string array |
+APIGroups is the API groups the resources belong to. '' is all groups. If '' is present, the length of the slice must be one. Required. | +
apiVersions string array |
+APIVersions is the API versions the resources belong to. '' is all versions. If '' is present, the length of the slice must be one. Required. | +
operations string array |
+Operations is the operations the admission hook cares about - CREATE, UPDATE, or for all operations. If '' is present, the length of the slice must be one. Required. | +
resources string array |
+Resources is a list of resources this rule applies to. For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '' means all resources, but not subresources. 'pods/' means all subresources of pods. '/scale' means all scale subresources. '/*' means all resources and their subresources. If wildcard is present, the validation rule will ensure resources do not overlap with each other. Depending on the enclosing object, subresources might not be allowed. Required. | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +RunAsUserStrategyOptions | +
Run A sUser Strategy Options defines the strategy type and any options used to create the strategy.
+ + +Field | +Description | +
---|---|
ranges IDRange array |
+Ranges are the allowed ranges of uids that may be used. | +
rule string |
+Rule is the strategy that will dictate the allowable RunAsUser values that may be set. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +SELinuxOptions | +
SELinuxOptions are the labels to be applied to the container
+ + +Field | +Description | +
---|---|
level string |
+Level is SELinux level label that applies to the container. | +
role string |
+Role is a SELinux role label that applies to the container. | +
type string |
+Type is a SELinux type label that applies to the container. | +
user string |
+User is a SELinux user label that applies to the container. | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +SELinuxStrategyOptions | +
SELinux Strategy Options defines the strategy type and any options used to create the strategy.
+ + +Field | +Description | +
---|---|
rule string |
+type is the strategy that will dictate the allowable labels that may be set. | +
seLinuxOptions SELinuxOptions |
+seLinuxOptions required to run as; required for MustRunAs More info: https://git.k8s.io/community/contributors/design-proposals/security_context.md | +
Group | +Version | +Kind | +
---|---|---|
autoscaling | +v1 | +Scale | +
Scale represents a scaling request for a resource.
+Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata. | +
spec ScaleSpec |
+defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. | +
status ScaleStatus |
+current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ScaleIOVolumeSource | +
ScaleIOVolumeSource represents a persistent ScaleIO volume
+ + +Field | +Description | +
---|---|
fsType string |
+Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. | +
gateway string |
+The host address of the ScaleIO API Gateway. | +
protectionDomain string |
+The name of the Protection Domain for the configured storage (defaults to "default"). | +
readOnly boolean |
+Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | +
secretRef LocalObjectReference |
+SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. | +
sslEnabled boolean |
+Flag to enable/disable SSL communication with Gateway, default false | +
storageMode string |
+Indicates whether the storage for a volume should be thick or thin (defaults to "thin"). | +
storagePool string |
+The Storage Pool associated with the protection domain (defaults to "default"). | +
system string |
+The name of the storage system as configured in ScaleIO. | +
volumeName string |
+The name of a volume already created in the ScaleIO system that is associated with this volume source. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +SecretEnvSource | +
SecretEnvSource selects a Secret to populate the environment variables with.
+The contents of the target Secret's Data field will represent the key-value pairs as environment variables.
+ + +Field | +Description | +
---|---|
name string |
+Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | +
optional boolean |
+Specify whether the Secret must be defined | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +SecretKeySelector | +
SecretKeySelector selects a key of a Secret.
+ + +Field | +Description | +
---|---|
key string |
+The key of the secret to select from. Must be a valid secret key. | +
name string |
+Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | +
optional boolean |
+Specify whether the Secret or it's key must be defined | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +SecretProjection | +
Adapts a secret into a projected volume.
+The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.
+ + +Field | +Description | +
---|---|
items KeyToPath array |
+If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. | +
name string |
+Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | +
optional boolean |
+Specify whether the Secret or its key must be defined | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +SecretReference | +
SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
+ + +Field | +Description | +
---|---|
name string |
+Name is unique within a namespace to reference a secret resource. | +
namespace string |
+Namespace defines the space within which the secret name must be unique. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +SecretVolumeSource | +
Adapts a Secret into a volume.
+The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.
+ + +Field | +Description | +
---|---|
defaultMode integer |
+Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | +
items KeyToPath array |
+If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. | +
optional boolean |
+Specify whether the Secret or it's keys must be defined | +
secretName string |
+Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +SecurityContext | +
SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.
+ + +Field | +Description | +
---|---|
allowPrivilegeEscalation boolean |
+AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN | +
capabilities Capabilities |
+The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. | +
privileged boolean |
+Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. | +
readOnlyRootFilesystem boolean |
+Whether this container has a read-only root filesystem. Default is false. | +
runAsNonRoot boolean |
+Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. | +
runAsUser integer |
+The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. | +
seLinuxOptions SELinuxOptions |
+The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. | +
Group | +Version | +Kind | +
---|---|---|
meta | +v1 | +ServerAddressByClientCIDR | +
ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.
+ + +Field | +Description | +
---|---|
clientCIDR string |
+The CIDR with which clients can match their IP to figure out the server address that they should use. | +
serverAddress string |
+Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +ServicePort | +
ServicePort contains information on service's port.
+ + +Field | +Description | +
---|---|
name string |
+The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. This maps to the 'Name' field in EndpointPort objects. Optional if only one ServicePort is defined on this service. | +
nodePort integer |
+The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport | +
port integer |
+The port that will be exposed by this service. | +
protocol string |
+The IP protocol for this port. Supports "TCP" and "UDP". Default is TCP. | +
targetPort | +Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service | +
Group | +Version | +Kind | +
---|---|---|
apiregistration | +v1beta1 | +ServiceReference | +
ServiceReference holds a reference to Service.legacy.k8s.io
+ + +Field | +Description | +
---|---|
name string |
+Name is the name of the service | +
namespace string |
+Namespace is the namespace of the service | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +SessionAffinityConfig | +
SessionAffinityConfig represents the configurations of session affinity.
+ + +Field | +Description | +
---|---|
clientIP ClientIPConfig |
+clientIP contains the configurations of Client IP based session affinity. | +
Group | +Version | +Kind | +
---|---|---|
apps | +v1beta1 | +StatefulSetUpdateStrategy | +
StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.
+ + +Field | +Description | +
---|---|
rollingUpdate RollingUpdateStatefulSetStrategy |
+RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType. | +
type string |
+Type indicates the type of the StatefulSetUpdateStrategy. | +
Group | +Version | +Kind | +
---|---|---|
meta | +v1 | +Status | +
Status is a return value for calls that don't return other objects.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
code integer |
+Suggested HTTP return code for this status, 0 if not set. | +
details StatusDetails |
+Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
message string |
+A human-readable description of the status of this operation. | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
reason string |
+A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. | +
status string |
+Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
Group | +Version | +Kind | +
---|---|---|
meta | +v1 | +StatusCause | +
StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
+ + +Field | +Description | +
---|---|
field string |
+The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items" | +
message string |
+A human-readable description of the cause of the error. This field may be presented as-is to a reader. | +
reason string |
+A machine-readable description of the cause of the error. If this value is empty there is no information available. | +
Group | +Version | +Kind | +
---|---|---|
meta | +v1 | +StatusDetails | +
StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.
+ + +Field | +Description | +
---|---|
causes StatusCause array |
+The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. | +
group string |
+The group attribute of the resource associated with the status StatusReason. | +
kind string |
+The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
name string |
+The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). | +
retryAfterSeconds integer |
+If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action. | +
uid string |
+UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +StorageOSPersistentVolumeSource | +
Represents a StorageOS persistent volume resource.
+ + +Field | +Description | +
---|---|
fsType string |
+Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. | +
readOnly boolean |
+Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | +
secretRef ObjectReference |
+SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. | +
volumeName string |
+VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. | +
volumeNamespace string |
+VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +StorageOSVolumeSource | +
Represents a StorageOS persistent volume resource.
+ + +Field | +Description | +
---|---|
fsType string |
+Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. | +
readOnly boolean |
+Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | +
secretRef LocalObjectReference |
+SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. | +
volumeName string |
+VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. | +
volumeNamespace string |
+VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. | +
Group | +Version | +Kind | +
---|---|---|
rbac | +v1 | +Subject | +
Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.
+ + +Field | +Description | +
---|---|
apiGroup string |
+APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects. | +
kind string |
+Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error. | +
name string |
+Name of the object being referenced. | +
namespace string |
+Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error. | +
Group | +Version | +Kind | +
---|---|---|
authorization | +v1 | +SubjectRulesReviewStatus | +
SubjectRulesReviewStatus contains the result of a rules check. This check can be incomplete depending on the set of authorizers the server is configured with and any errors experienced during evaluation. Because authorization rules are additive, if a rule appears in a list it's safe to assume the subject has that permission, even if that list is incomplete.
+ + +Field | +Description | +
---|---|
evaluationError string |
+EvaluationError can appear in combination with Rules. It indicates an error occurred during rule evaluation, such as an authorizer that doesn't support rule evaluation, and that ResourceRules and/or NonResourceRules may be incomplete. | +
incomplete boolean |
+Incomplete is true when the rules returned by this call are incomplete. This is most commonly encountered when an authorizer, such as an external authorizer, doesn't support rules evaluation. | +
nonResourceRules NonResourceRule array |
+NonResourceRules is the list of actions the subject is allowed to perform on non-resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete. | +
resourceRules ResourceRule array |
+ResourceRules is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete. | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +SupplementalGroupsStrategyOptions | +
SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy.
+ + +Field | +Description | +
---|---|
ranges IDRange array |
+Ranges are the allowed ranges of supplemental groups. If you would like to force a single supplemental group then supply a single range with the same start and end. | +
rule string |
+Rule is the strategy that will dictate what supplemental groups is used in the SecurityContext. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +TCPSocketAction | +
TCPSocketAction describes an action based on opening a socket
+ + +Field | +Description | +
---|---|
host string |
+Optional: Host name to connect to, defaults to the pod IP. | +
port | +Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +Taint | +
The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.
+ + +Field | +Description | +
---|---|
effect string |
+Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute. | +
key string |
+Required. The taint key to be applied to a node. | +
timeAdded Time |
+TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints. | +
value string |
+Required. The taint value corresponding to the taint key. | +
Group | +Version | +Kind | +
---|---|---|
meta | +v1 | +Time | +
Field | +Description | +
---|---|
+ |
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +Toleration | +
The pod this Toleration is attached to tolerates any taint that matches the triple
Field | +Description | +
---|---|
effect string |
+Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. | +
key string |
+Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. | +
operator string |
+Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. | +
tolerationSeconds integer |
+TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. | +
value string |
+Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. | +
Group | +Version | +Kind | +
---|---|---|
authentication | +v1 | +UserInfo | +
UserInfo holds the information about the user needed to implement the user.Info interface.
+ + +Field | +Description | +
---|---|
extra object |
+Any additional information provided by the authenticator. | +
groups string array |
+The names of groups this user is a part of. | +
uid string |
+A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs. | +
username string |
+The name that uniquely identifies this user among all active users. | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +VolumeMount | +
VolumeMount describes a mounting of a Volume within a container.
+ + +Field | +Description | +
---|---|
mountPath string |
+Path within the container at which the volume should be mounted. Must not contain ':'. | +
mountPropagation string |
+mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationHostToContainer is used. This field is alpha in 1.8 and can be reworked or removed in a future release. | +
name string |
+This must match the Name of a Volume. | +
readOnly boolean |
+Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. | +
subPath string |
+Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +VolumeProjection | +
Projection that may be projected along with other supported volume types
+ + +Field | +Description | +
---|---|
configMap ConfigMapProjection |
+information about the configMap data to project | +
downwardAPI DownwardAPIProjection |
+information about the downwardAPI data to project | +
secret SecretProjection |
+information about the secret data to project | +
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +VsphereVirtualDiskVolumeSource | +
Represents a vSphere volume resource.
+ + +Field | +Description | +
---|---|
fsType string |
+Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. | +
storagePolicyID string |
+Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. | +
storagePolicyName string |
+Storage Policy Based Management (SPBM) profile name. | +
volumePath string |
+Path that identifies vSphere volume vmdk | +
Group | +Version | +Kind | +
---|---|---|
meta | +v1 | +WatchEvent | +
Event represents a single event to a watched resource.
+Field | +Description | +
---|---|
object | +Object is: If Type is Added or Modified: the new state of the object. If Type is Deleted: the state of the object immediately before deletion. If Type is Error: Status is recommended; other types may make sense depending on context. | +
type string |
++ |
Group | +Version | +Kind | +
---|---|---|
Core | +v1 | +WeightedPodAffinityTerm | +
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
+ + +Field | +Description | +
---|---|
podAffinityTerm PodAffinityTerm |
+Required. A pod affinity term, associated with the corresponding weight. | +
weight integer |
+weight associated with matching the corresponding podAffinityTerm, in the range 1-100. | +
This section contains older versions of resources shown above.
+Group | +Version | +Kind | +
---|---|---|
rbac | +v1beta1 | +ClusterRole | +
ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. | +
rules PolicyRule array |
+Rules holds all the PolicyRules for this ClusterRole | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items ClusterRole array |
+Items is a list of ClusterRoles | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard object's metadata. | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a ClusterRole
+POST /apis/rbac.authorization.k8s.io/v1beta1/clusterroles
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ClusterRole |
++ |
Code | +Description | +
---|---|
200 ClusterRole |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified ClusterRole
+PATCH /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRole | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 ClusterRole |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified ClusterRole
+PUT /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRole | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ClusterRole |
++ |
Code | +Description | +
---|---|
200 ClusterRole |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a ClusterRole
+DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRole | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of ClusterRole
+DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterroles
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified ClusterRole
+GET /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRole | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 ClusterRole |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind ClusterRole
+GET /apis/rbac.authorization.k8s.io/v1beta1/clusterroles
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ClusterRoleList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind ClusterRole
+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterroles/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRole | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of ClusterRole
+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterroles
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
rbac | +v1alpha1 | +ClusterRole | +
ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. | +
rules PolicyRule array |
+Rules holds all the PolicyRules for this ClusterRole | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items ClusterRole array |
+Items is a list of ClusterRoles | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard object's metadata. | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a ClusterRole
+POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ClusterRole |
++ |
Code | +Description | +
---|---|
200 ClusterRole |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified ClusterRole
+PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRole | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 ClusterRole |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified ClusterRole
+PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRole | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ClusterRole |
++ |
Code | +Description | +
---|---|
200 ClusterRole |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a ClusterRole
+DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRole | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of ClusterRole
+DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified ClusterRole
+GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRole | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 ClusterRole |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind ClusterRole
+GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ClusterRoleList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind ClusterRole
+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRole | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of ClusterRole
+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
rbac | +v1beta1 | +ClusterRoleBinding | +
ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. | +
roleRef RoleRef |
+RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. | +
subjects Subject array |
+Subjects holds references to the objects the role applies to. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items ClusterRoleBinding array |
+Items is a list of ClusterRoleBindings | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard object's metadata. | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a ClusterRoleBinding
+POST /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ClusterRoleBinding |
++ |
Code | +Description | +
---|---|
200 ClusterRoleBinding |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified ClusterRoleBinding
+PATCH /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRoleBinding | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 ClusterRoleBinding |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified ClusterRoleBinding
+PUT /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRoleBinding | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ClusterRoleBinding |
++ |
Code | +Description | +
---|---|
200 ClusterRoleBinding |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a ClusterRoleBinding
+DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRoleBinding | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of ClusterRoleBinding
+DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified ClusterRoleBinding
+GET /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRoleBinding | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 ClusterRoleBinding |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind ClusterRoleBinding
+GET /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ClusterRoleBindingList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind ClusterRoleBinding
+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterrolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRoleBinding | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of ClusterRoleBinding
+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterrolebindings
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
rbac | +v1alpha1 | +ClusterRoleBinding | +
ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. | +
roleRef RoleRef |
+RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. | +
subjects Subject array |
+Subjects holds references to the objects the role applies to. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items ClusterRoleBinding array |
+Items is a list of ClusterRoleBindings | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard object's metadata. | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a ClusterRoleBinding
+POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ClusterRoleBinding |
++ |
Code | +Description | +
---|---|
200 ClusterRoleBinding |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified ClusterRoleBinding
+PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRoleBinding | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 ClusterRoleBinding |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified ClusterRoleBinding
+PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRoleBinding | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ClusterRoleBinding |
++ |
Code | +Description | +
---|---|
200 ClusterRoleBinding |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a ClusterRoleBinding
+DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRoleBinding | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of ClusterRoleBinding
+DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified ClusterRoleBinding
+GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRoleBinding | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 ClusterRoleBinding |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind ClusterRoleBinding
+GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ClusterRoleBindingList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind ClusterRoleBinding
+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the ClusterRoleBinding | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of ClusterRoleBinding
+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
apps | +v1beta2 | +ControllerRevision | +
ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
data | +Data is the serialized representation of the state. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
revision integer |
+Revision indicates the revision of the state represented by Data. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items ControllerRevision array |
+Items is the list of ControllerRevisions | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a ControllerRevision
+POST /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ControllerRevision |
++ |
Code | +Description | +
---|---|
200 ControllerRevision |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified ControllerRevision
+PATCH /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions/{name}
Parameter | +Description | +
---|---|
name | +name of the ControllerRevision | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 ControllerRevision |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified ControllerRevision
+PUT /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions/{name}
Parameter | +Description | +
---|---|
name | +name of the ControllerRevision | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ControllerRevision |
++ |
Code | +Description | +
---|---|
200 ControllerRevision |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a ControllerRevision
+DELETE /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions/{name}
Parameter | +Description | +
---|---|
name | +name of the ControllerRevision | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of ControllerRevision
+DELETE /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified ControllerRevision
+GET /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions/{name}
Parameter | +Description | +
---|---|
name | +name of the ControllerRevision | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 ControllerRevision |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind ControllerRevision
+GET /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ControllerRevisionList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind ControllerRevision
+GET /apis/apps/v1beta2/controllerrevisions
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ControllerRevisionList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind ControllerRevision
+GET /apis/apps/v1beta2/watch/namespaces/{namespace}/controllerrevisions/{name}
Parameter | +Description | +
---|---|
name | +name of the ControllerRevision | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of ControllerRevision
+GET /apis/apps/v1beta2/watch/namespaces/{namespace}/controllerrevisions
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of ControllerRevision
+GET /apis/apps/v1beta2/watch/controllerrevisions
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
batch | +v2alpha1 | +CronJob | +
CronJob represents the configuration of a single cron job.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec CronJobSpec |
+Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
status CronJobStatus |
+Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
Field | +Description | +
---|---|
concurrencyPolicy string |
+Specifies how to treat concurrent executions of a Job. Defaults to Allow. | +
failedJobsHistoryLimit integer |
+The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. | +
jobTemplate JobTemplateSpec |
+Specifies the job that will be created when executing a CronJob. | +
schedule string |
+The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. | +
startingDeadlineSeconds integer |
+Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. | +
successfulJobsHistoryLimit integer |
+The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. | +
suspend boolean |
+This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false. | +
Field | +Description | +
---|---|
active ObjectReference array |
+A list of pointers to currently running jobs. | +
lastScheduleTime Time |
+Information when was the last time the job was successfully scheduled. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items CronJob array |
+items is the list of CronJobs. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a CronJob
+POST /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body CronJob |
++ |
Code | +Description | +
---|---|
200 CronJob |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified CronJob
+PATCH /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}
Parameter | +Description | +
---|---|
name | +name of the CronJob | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 CronJob |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified CronJob
+PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}
Parameter | +Description | +
---|---|
name | +name of the CronJob | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body CronJob |
++ |
Code | +Description | +
---|---|
200 CronJob |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a CronJob
+DELETE /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}
Parameter | +Description | +
---|---|
name | +name of the CronJob | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of CronJob
+DELETE /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified CronJob
+GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}
Parameter | +Description | +
---|---|
name | +name of the CronJob | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 CronJob |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind CronJob
+GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 CronJobList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind CronJob
+GET /apis/batch/v2alpha1/cronjobs
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 CronJobList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind CronJob
+GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/cronjobs/{name}
Parameter | +Description | +
---|---|
name | +name of the CronJob | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of CronJob
+GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/cronjobs
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of CronJob
+GET /apis/batch/v2alpha1/watch/cronjobs
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update status of the specified CronJob
+PATCH /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status
Parameter | +Description | +
---|---|
name | +name of the CronJob | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 CronJob |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read status of the specified CronJob
+GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status
Parameter | +Description | +
---|---|
name | +name of the CronJob | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 CronJob |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified CronJob
+PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status
Parameter | +Description | +
---|---|
name | +name of the CronJob | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body CronJob |
++ |
Code | +Description | +
---|---|
200 CronJob |
+OK | +
Group | +Version | +Kind | +
---|---|---|
autoscaling | +v2beta1 | +CrossVersionObjectReference | +
CrossVersionObjectReference contains enough information to let you identify the referred resource.
+ + +Field | +Description | +
---|---|
apiVersion string |
+API version of the referent | +
kind string |
+Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds" | +
name string |
+Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names | +
Group | +Version | +Kind | +
---|---|---|
apps | +v1beta2 | +DaemonSet | +
DaemonSet represents the configuration of a daemon set.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec DaemonSetSpec |
+The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
status DaemonSetStatus |
+The current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
Field | +Description | +
---|---|
minReadySeconds integer |
+The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready). | +
revisionHistoryLimit integer |
+The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. | +
selector LabelSelector |
+A label query over pods that are managed by the daemon set. Must match in order to be controlled. If empty, defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | +
template PodTemplateSpec |
+An object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template | +
updateStrategy DaemonSetUpdateStrategy |
+An update strategy to replace existing DaemonSet pods with new pods. | +
Field | +Description | +
---|---|
collisionCount integer |
+Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision. | +
currentNumberScheduled integer |
+The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ | +
desiredNumberScheduled integer |
+The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ | +
numberAvailable integer |
+The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds) | +
numberMisscheduled integer |
+The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ | +
numberReady integer |
+The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready. | +
numberUnavailable integer |
+The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds) | +
observedGeneration integer |
+The most recent generation observed by the daemon set controller. | +
updatedNumberScheduled integer |
+The total number of nodes that are running updated daemon pod | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items DaemonSet array |
+A list of daemon sets. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
Field | +Description | +
---|---|
maxUnavailable | +The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0. Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update. | +
See supported operations below...
++++
kubectl
Command
+$ echo 'apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+ name: daemonset-example
+spec:
+ template:
+ metadata:
+ labels:
+ app: daemonset-example
+ spec:
+ containers:
+ - name: daemonset-example
+ image: ubuntu:trusty
+ command:
+ - /bin/sh
+ args:
+ - -c
+ - >-
+ while [ true ]; do
+ echo "DaemonSet running on $(hostname)" ;
+ sleep 10 ;
+ done
+' | kubectl create -f -
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+ name: daemonset-example
+spec:
+ template:
+ metadata:
+ labels:
+ app: daemonset-example
+ spec:
+ containers:
+ - name: daemonset-example
+ image: ubuntu:trusty
+ command:
+ - /bin/sh
+ args:
+ - -c
+ - >-
+ while [ true ]; do
+ echo "DaemonSet running on $(hostname)" ;
+ sleep 10 ;
+ done
+' http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/daemonsets
+
+++Output
+
+daemonset "daemonset-example" created
+
+++Response Body
+
+{
+ "kind": "DaemonSet",
+ "apiVersion": "extensions/v1beta1",
+ "metadata": {
+ "name": "daemonset-example",
+ "namespace": "default",
+ "selfLink": "/apis/extensions/v1beta1/namespaces/default/daemonsets/daemonset-example",
+ "uid": "65552ced-b0e2-11e6-aef0-42010af00229",
+ "resourceVersion": "3558",
+ "generation": 1,
+ "creationTimestamp": "2016-11-22T18:35:09Z",
+ "labels": {
+ "app": "daemonset-example"
+ }
+ },
+ "spec": {
+ "selector": {
+ "matchLabels": {
+ "app": "daemonset-example"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "daemonset-example"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "daemonset-example",
+ "image": "ubuntu:trusty",
+ "command": [
+ "/bin/sh"
+ ],
+ "args": [
+ "-c",
+ "while [ true ]; do echo \"DaemonSet running on $(hostname)\" ; sleep 10 ; done"
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ }
+ },
+ "status": {
+ "currentNumberScheduled": 0,
+ "numberMisscheduled": 0,
+ "desiredNumberScheduled": 0
+ }
+}
+
+create a DaemonSet
+POST /apis/apps/v1beta2/namespaces/{namespace}/daemonsets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body DaemonSet |
++ |
Code | +Description | +
---|---|
200 DaemonSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified DaemonSet
+PATCH /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}
Parameter | +Description | +
---|---|
name | +name of the DaemonSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 DaemonSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified DaemonSet
+PUT /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}
Parameter | +Description | +
---|---|
name | +name of the DaemonSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body DaemonSet |
++ |
Code | +Description | +
---|---|
200 DaemonSet |
+OK | +
+++
kubectl
Command
+$ kubectl delete daemonset daemonset-example
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/daemonsets/daemonset-example'
+
+++Output
+
+daemonset "daemonset-example" deleted
+
+++Response Body
+
+{
+ "kind": "Status",
+ "apiVersion": "v1",
+ "metadata": {},
+ "status": "Success",
+ "code": 200
+}
+
+delete a DaemonSet
+DELETE /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}
Parameter | +Description | +
---|---|
name | +name of the DaemonSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of DaemonSet
+DELETE /apis/apps/v1beta2/namespaces/{namespace}/daemonsets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+$ kubectl get daemonset daemonset-example -o json
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X GET http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/daemonsets/daemonset-example
+
+++Output
+
+
+++Response Body
+
+
+read the specified DaemonSet
+GET /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}
Parameter | +Description | +
---|---|
name | +name of the DaemonSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 DaemonSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind DaemonSet
+GET /apis/apps/v1beta2/namespaces/{namespace}/daemonsets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 DaemonSetList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind DaemonSet
+GET /apis/apps/v1beta2/daemonsets
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 DaemonSetList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind DaemonSet
+GET /apis/apps/v1beta2/watch/namespaces/{namespace}/daemonsets/{name}
Parameter | +Description | +
---|---|
name | +name of the DaemonSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of DaemonSet
+GET /apis/apps/v1beta2/watch/namespaces/{namespace}/daemonsets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of DaemonSet
+GET /apis/apps/v1beta2/watch/daemonsets
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update status of the specified DaemonSet
+PATCH /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}/status
Parameter | +Description | +
---|---|
name | +name of the DaemonSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 DaemonSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read status of the specified DaemonSet
+GET /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}/status
Parameter | +Description | +
---|---|
name | +name of the DaemonSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 DaemonSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified DaemonSet
+PUT /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}/status
Parameter | +Description | +
---|---|
name | +name of the DaemonSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body DaemonSet |
++ |
Code | +Description | +
---|---|
200 DaemonSet |
+OK | +
Group | +Version | +Kind | +
---|---|---|
apps | +v1beta2 | +DaemonSetUpdateStrategy | +
DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.
+ + +Field | +Description | +
---|---|
rollingUpdate RollingUpdateDaemonSet |
+Rolling update config params. Present only if type = "RollingUpdate". | +
type string |
+Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate. | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +Deployment | +
DEPRECATED - This group version of Deployment is deprecated by apps/v1beta2/Deployment. See the release notes for more information. Deployment enables declarative updates for Pods and ReplicaSets.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object metadata. | +
spec DeploymentSpec |
+Specification of the desired behavior of the Deployment. | +
status DeploymentStatus |
+Most recently observed status of the Deployment. | +
Field | +Description | +
---|---|
minReadySeconds integer |
+Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) | +
paused boolean |
+Indicates that the deployment is paused and will not be processed by the deployment controller. | +
progressDeadlineSeconds integer |
+The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. This is not set by default. | +
replicas integer |
+Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. | +
revisionHistoryLimit integer |
+The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. | +
rollbackTo RollbackConfig |
+DEPRECATED. The config this deployment is rolling back to. Will be cleared after rollback is done. | +
selector LabelSelector |
+Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. | +
strategy DeploymentStrategy patch type: retainKeys |
+The deployment strategy to use to replace existing pods with new ones. | +
template PodTemplateSpec |
+Template describes the pods that will be created. | +
Field | +Description | +
---|---|
availableReplicas integer |
+Total number of available pods (ready for at least minReadySeconds) targeted by this deployment. | +
collisionCount integer |
+Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet. | +
conditions DeploymentCondition array patch type: merge patch merge key: type |
+Represents the latest available observations of a deployment's current state. | +
observedGeneration integer |
+The generation observed by the deployment controller. | +
readyReplicas integer |
+Total number of ready pods targeted by this deployment. | +
replicas integer |
+Total number of non-terminated pods targeted by this deployment (their labels match the selector). | +
unavailableReplicas integer |
+Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created. | +
updatedReplicas integer |
+Total number of non-terminated pods targeted by this deployment that have the desired template spec. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items Deployment array |
+Items is the list of Deployments. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. | +
Field | +Description | +
---|---|
rollingUpdate RollingUpdateDeployment |
+Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. | +
type string |
+Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
name string |
+Required: This must match the Name of a deployment. | +
rollbackTo RollbackConfig |
+The config of this deployment rollback. | +
updatedAnnotations object |
+The annotations to be updated to a deployment | +
Field | +Description | +
---|---|
maxSurge | +The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. By default, a value of 1 is used. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods. | +
maxUnavailable | +The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. By default, a fixed value of 1 is used. Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. | +
See supported operations below...
++++
kubectl
Command
+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.10
+ ports:
+ - containerPort: 80
+' | kubectl create -f -
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.10
+ ports:
+ - containerPort: 80
+' http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/deployments
+
+++Output
+
+deployment "deployment-example" created
+
+++Response Body
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
+ "resourceVersion": "2118306",
+ "generation": 1,
+ "creationTimestamp": "2016-10-28T01:53:19Z",
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ },
+ "revisionHistoryLimit": 10
+ },
+ "status": {}
+}
+
+create a Deployment
+POST /apis/extensions/v1beta1/namespaces/{namespace}/deployments
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Deployment |
++ |
Code | +Description | +
---|---|
200 Deployment |
+OK | +
+++
kubectl
Command
+$ kubectl patch deployment deployment-example -p \
+ '{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}'
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X PATCH -H 'Content-Type: application/strategic-merge-patch+json' --data '
+{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}' \
+ 'http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/deployments/deployment-example'
+
+++Output
+
+"deployment-example" patched
+
+++Response Body
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "5dc3a8e6-b0ee-11e6-aef0-42010af00229",
+ "resourceVersion": "164489",
+ "generation": 11,
+ "creationTimestamp": "2016-11-22T20:00:50Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "5"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.11",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ },
+ "revisionHistoryLimit": 10
+ },
+ "status": {
+ "observedGeneration": 10,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+partially update the specified Deployment
+PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}
Parameter | +Description | +
---|---|
name | +name of the Deployment | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 Deployment |
+OK | +
+++
kubectl
Command
+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.11
+ ports:
+ - containerPort: 80
+' | kubectl replace -f -
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X PUT -H 'Content-Type: application/yaml' --data '
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.11
+ ports:
+ - containerPort: 80
+' http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/deployments/deployment-example
+
+++Output
+
+deployment "deployment-example" replaced
+
+++Response Body
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
+ "resourceVersion": "2119082",
+ "generation": 5,
+ "creationTimestamp": "2016-10-28T01:53:19Z",
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.11",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ },
+ "revisionHistoryLimit": 10
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+replace the specified Deployment
+PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}
Parameter | +Description | +
---|---|
name | +name of the Deployment | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Deployment |
++ |
Code | +Description | +
---|---|
200 Deployment |
+OK | +
+++
kubectl
Command
+$ kubectl delete deployment deployment-example
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/deployments/deployment-example'
+
+++Output
+
+deployment "deployment-example" deleted
+
+++Response Body
+
+{
+ "kind": "Status",
+ "apiVersion": "v1",
+ "metadata": {},
+ "status": "Success",
+ "code": 200
+}
+
+delete a Deployment
+DELETE /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}
Parameter | +Description | +
---|---|
name | +name of the Deployment | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of Deployment
+DELETE /apis/extensions/v1beta1/namespaces/{namespace}/deployments
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+$ kubectl get deployment deployment-example -o json
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X GET http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/deployments/deployment-example
+
+++Output
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+++Response Body
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+read the specified Deployment
+GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}
Parameter | +Description | +
---|---|
name | +name of the Deployment | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 Deployment |
+OK | +
+++
kubectl
Command
+$ kubectl get deployment -o json
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/deployments'
+
+++Output
+
+{
+ "kind": "List",
+ "apiVersion": "v1",
+ "metadata": {},
+ "items": [
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "docs",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
+ "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
+ "resourceVersion": "1924126",
+ "generation": 21,
+ "creationTimestamp": "2016-10-13T16:06:00Z",
+ "labels": {
+ "run": "docs"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "10",
+ "replicatingperfection.net/push-image": "true"
+ }
+ },
+ "spec": {
+ "replicas": 1,
+ "selector": {
+ "matchLabels": {
+ "run": "docs"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "auto-pushed-image-pwittrock/api-docs": "1477496453",
+ "run": "docs"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "docs",
+ "image": "pwittrock/api-docs:v9",
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 21,
+ "replicas": 1,
+ "updatedReplicas": 1,
+ "availableReplicas": 1
+ }
+ },
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+ ]
+}
+
+++Response Body
+
+{
+ "kind": "List",
+ "apiVersion": "v1",
+ "metadata": {},
+ "items": [
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "docs",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
+ "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
+ "resourceVersion": "1924126",
+ "generation": 21,
+ "creationTimestamp": "2016-10-13T16:06:00Z",
+ "labels": {
+ "run": "docs"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "10",
+ "replicatingperfection.net/push-image": "true"
+ }
+ },
+ "spec": {
+ "replicas": 1,
+ "selector": {
+ "matchLabels": {
+ "run": "docs"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "auto-pushed-image-pwittrock/api-docs": "1477496453",
+ "run": "docs"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "docs",
+ "image": "pwittrock/api-docs:v9",
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 21,
+ "replicas": 1,
+ "updatedReplicas": 1,
+ "availableReplicas": 1
+ }
+ },
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+ ]
+}
+
+list or watch objects of kind Deployment
+GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 DeploymentList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind Deployment
+GET /apis/extensions/v1beta1/deployments
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 DeploymentList |
+OK | +
+++
kubectl
Command
+$ kubectl get deployment deployment-example --watch -o json
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/extensions/v1beta1/watch/namespaces/default/deployments/deployment-example'
+
+++Output
+
+{
+ "type": "ADDED",
+ "object": {
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "64c12290-9cbf-11e6-9c54-42010a800148",
+ "resourceVersion": "2128095",
+ "generation": 2,
+ "creationTimestamp": "2016-10-28T03:34:12Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "3"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {
+ },
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {
+ }
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 2,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+}
+
+++Response Body
+
+{
+ "type": "ADDED",
+ "object": {
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "64c12290-9cbf-11e6-9c54-42010a800148",
+ "resourceVersion": "2128095",
+ "generation": 2,
+ "creationTimestamp": "2016-10-28T03:34:12Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "3"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {
+ },
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {
+ }
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 2,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+}
+
+watch changes to an object of kind Deployment
+GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/deployments/{name}
Parameter | +Description | +
---|---|
name | +name of the Deployment | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Deployment
+GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/deployments
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Deployment
+GET /apis/extensions/v1beta1/watch/deployments
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update status of the specified Deployment
+PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Deployment | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 Deployment |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read status of the specified Deployment
+GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Deployment | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 Deployment |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified Deployment
+PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Deployment | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Deployment |
++ |
Code | +Description | +
---|---|
200 Deployment |
+OK | +
Group | +Version | +Kind | +
---|---|---|
apps | +v1beta2 | +Deployment | +
Deployment enables declarative updates for Pods and ReplicaSets.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object metadata. | +
spec DeploymentSpec |
+Specification of the desired behavior of the Deployment. | +
status DeploymentStatus |
+Most recently observed status of the Deployment. | +
Field | +Description | +
---|---|
minReadySeconds integer |
+Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) | +
paused boolean |
+Indicates that the deployment is paused. | +
progressDeadlineSeconds integer |
+The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s. | +
replicas integer |
+Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. | +
revisionHistoryLimit integer |
+The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. | +
selector LabelSelector |
+Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. | +
strategy DeploymentStrategy |
+The deployment strategy to use to replace existing pods with new ones. | +
template PodTemplateSpec |
+Template describes the pods that will be created. | +
Field | +Description | +
---|---|
availableReplicas integer |
+Total number of available pods (ready for at least minReadySeconds) targeted by this deployment. | +
collisionCount integer |
+Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet. | +
conditions DeploymentCondition array patch type: merge patch merge key: type |
+Represents the latest available observations of a deployment's current state. | +
observedGeneration integer |
+The generation observed by the deployment controller. | +
readyReplicas integer |
+Total number of ready pods targeted by this deployment. | +
replicas integer |
+Total number of non-terminated pods targeted by this deployment (their labels match the selector). | +
unavailableReplicas integer |
+Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created. | +
updatedReplicas integer |
+Total number of non-terminated pods targeted by this deployment that have the desired template spec. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items Deployment array |
+Items is the list of Deployments. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. | +
Field | +Description | +
---|---|
rollingUpdate RollingUpdateDeployment |
+Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. | +
type string |
+Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. | +
Field | +Description | +
---|---|
maxSurge | +The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods. | +
maxUnavailable | +The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. | +
See supported operations below...
++++
kubectl
Command
+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.10
+ ports:
+ - containerPort: 80
+' | kubectl create -f -
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.10
+ ports:
+ - containerPort: 80
+' http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/deployments
+
+++Output
+
+deployment "deployment-example" created
+
+++Response Body
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
+ "resourceVersion": "2118306",
+ "generation": 1,
+ "creationTimestamp": "2016-10-28T01:53:19Z",
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ },
+ "revisionHistoryLimit": 10
+ },
+ "status": {}
+}
+
+create a Deployment
+POST /apis/apps/v1beta2/namespaces/{namespace}/deployments
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Deployment |
++ |
Code | +Description | +
---|---|
200 Deployment |
+OK | +
+++
kubectl
Command
+$ kubectl patch deployment deployment-example -p \
+ '{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}'
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X PATCH -H 'Content-Type: application/strategic-merge-patch+json' --data '
+{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}' \
+ 'http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/deployments/deployment-example'
+
+++Output
+
+"deployment-example" patched
+
+++Response Body
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "5dc3a8e6-b0ee-11e6-aef0-42010af00229",
+ "resourceVersion": "164489",
+ "generation": 11,
+ "creationTimestamp": "2016-11-22T20:00:50Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "5"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.11",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ },
+ "revisionHistoryLimit": 10
+ },
+ "status": {
+ "observedGeneration": 10,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+partially update the specified Deployment
+PATCH /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}
Parameter | +Description | +
---|---|
name | +name of the Deployment | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 Deployment |
+OK | +
+++
kubectl
Command
+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.11
+ ports:
+ - containerPort: 80
+' | kubectl replace -f -
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X PUT -H 'Content-Type: application/yaml' --data '
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+ name: deployment-example
+spec:
+ replicas: 3
+ revisionHistoryLimit: 10
+ template:
+ metadata:
+ labels:
+ app: nginx
+ spec:
+ containers:
+ - name: nginx
+ image: nginx:1.11
+ ports:
+ - containerPort: 80
+' http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/deployments/deployment-example
+
+++Output
+
+deployment "deployment-example" replaced
+
+++Response Body
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
+ "resourceVersion": "2119082",
+ "generation": 5,
+ "creationTimestamp": "2016-10-28T01:53:19Z",
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.11",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ },
+ "revisionHistoryLimit": 10
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+replace the specified Deployment
+PUT /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}
Parameter | +Description | +
---|---|
name | +name of the Deployment | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Deployment |
++ |
Code | +Description | +
---|---|
200 Deployment |
+OK | +
+++
kubectl
Command
+$ kubectl delete deployment deployment-example
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/deployments/deployment-example'
+
+++Output
+
+deployment "deployment-example" deleted
+
+++Response Body
+
+{
+ "kind": "Status",
+ "apiVersion": "v1",
+ "metadata": {},
+ "status": "Success",
+ "code": 200
+}
+
+delete a Deployment
+DELETE /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}
Parameter | +Description | +
---|---|
name | +name of the Deployment | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of Deployment
+DELETE /apis/apps/v1beta2/namespaces/{namespace}/deployments
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+$ kubectl get deployment deployment-example -o json
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X GET http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/deployments/deployment-example
+
+++Output
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+++Response Body
+
+{
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+}
+
+read the specified Deployment
+GET /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}
Parameter | +Description | +
---|---|
name | +name of the Deployment | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 Deployment |
+OK | +
+++
kubectl
Command
+$ kubectl get deployment -o json
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/deployments'
+
+++Output
+
+{
+ "kind": "List",
+ "apiVersion": "v1",
+ "metadata": {},
+ "items": [
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "docs",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
+ "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
+ "resourceVersion": "1924126",
+ "generation": 21,
+ "creationTimestamp": "2016-10-13T16:06:00Z",
+ "labels": {
+ "run": "docs"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "10",
+ "replicatingperfection.net/push-image": "true"
+ }
+ },
+ "spec": {
+ "replicas": 1,
+ "selector": {
+ "matchLabels": {
+ "run": "docs"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "auto-pushed-image-pwittrock/api-docs": "1477496453",
+ "run": "docs"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "docs",
+ "image": "pwittrock/api-docs:v9",
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 21,
+ "replicas": 1,
+ "updatedReplicas": 1,
+ "availableReplicas": 1
+ }
+ },
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+ ]
+}
+
+++Response Body
+
+{
+ "kind": "List",
+ "apiVersion": "v1",
+ "metadata": {},
+ "items": [
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "docs",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
+ "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
+ "resourceVersion": "1924126",
+ "generation": 21,
+ "creationTimestamp": "2016-10-13T16:06:00Z",
+ "labels": {
+ "run": "docs"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "10",
+ "replicatingperfection.net/push-image": "true"
+ }
+ },
+ "spec": {
+ "replicas": 1,
+ "selector": {
+ "matchLabels": {
+ "run": "docs"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "auto-pushed-image-pwittrock/api-docs": "1477496453",
+ "run": "docs"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "docs",
+ "image": "pwittrock/api-docs:v9",
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "Always"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 21,
+ "replicas": 1,
+ "updatedReplicas": 1,
+ "availableReplicas": 1
+ }
+ },
+ {
+ "kind": "Deployment",
+ "apiVersion": "app/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+ "resourceVersion": "2064726",
+ "generation": 4,
+ "creationTimestamp": "2016-10-27T16:33:35Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "1"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {},
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {}
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 4,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+ ]
+}
+
+list or watch objects of kind Deployment
+GET /apis/apps/v1beta2/namespaces/{namespace}/deployments
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 DeploymentList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind Deployment
+GET /apis/apps/v1beta2/deployments
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 DeploymentList |
+OK | +
+++
kubectl
Command
+$ kubectl get deployment deployment-example --watch -o json
+
++++
curl
Command (requireskubectl proxy
to be running)
+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1beta2/watch/namespaces/default/deployments/deployment-example'
+
+++Output
+
+{
+ "type": "ADDED",
+ "object": {
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "64c12290-9cbf-11e6-9c54-42010a800148",
+ "resourceVersion": "2128095",
+ "generation": 2,
+ "creationTimestamp": "2016-10-28T03:34:12Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "3"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {
+ },
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {
+ }
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 2,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+}
+
+++Response Body
+
+{
+ "type": "ADDED",
+ "object": {
+ "kind": "Deployment",
+ "apiVersion": "apps/v1beta1",
+ "metadata": {
+ "name": "deployment-example",
+ "namespace": "default",
+ "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+ "uid": "64c12290-9cbf-11e6-9c54-42010a800148",
+ "resourceVersion": "2128095",
+ "generation": 2,
+ "creationTimestamp": "2016-10-28T03:34:12Z",
+ "labels": {
+ "app": "nginx"
+ },
+ "annotations": {
+ "deployment.kubernetes.io/revision": "3"
+ }
+ },
+ "spec": {
+ "replicas": 3,
+ "selector": {
+ "matchLabels": {
+ "app": "nginx"
+ }
+ },
+ "template": {
+ "metadata": {
+ "creationTimestamp": null,
+ "labels": {
+ "app": "nginx"
+ }
+ },
+ "spec": {
+ "containers": [
+ {
+ "name": "nginx",
+ "image": "nginx:1.10",
+ "ports": [
+ {
+ "containerPort": 80,
+ "protocol": "TCP"
+ }
+ ],
+ "resources": {
+ },
+ "terminationMessagePath": "/dev/termination-log",
+ "imagePullPolicy": "IfNotPresent"
+ }
+ ],
+ "restartPolicy": "Always",
+ "terminationGracePeriodSeconds": 30,
+ "dnsPolicy": "ClusterFirst",
+ "securityContext": {
+ }
+ }
+ },
+ "strategy": {
+ "type": "RollingUpdate",
+ "rollingUpdate": {
+ "maxUnavailable": 1,
+ "maxSurge": 1
+ }
+ }
+ },
+ "status": {
+ "observedGeneration": 2,
+ "replicas": 3,
+ "updatedReplicas": 3,
+ "availableReplicas": 3
+ }
+ }
+}
+
+watch changes to an object of kind Deployment
+GET /apis/apps/v1beta2/watch/namespaces/{namespace}/deployments/{name}
Parameter | +Description | +
---|---|
name | +name of the Deployment | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Deployment
+GET /apis/apps/v1beta2/watch/namespaces/{namespace}/deployments
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Deployment
+GET /apis/apps/v1beta2/watch/deployments
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update status of the specified Deployment
+PATCH /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Deployment | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 Deployment |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read status of the specified Deployment
+GET /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Deployment | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 Deployment |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified Deployment
+PUT /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/status
Parameter | +Description | +
---|---|
name | +name of the Deployment | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Deployment |
++ |
Code | +Description | +
---|---|
200 Deployment |
+OK | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +DeploymentCondition | +
DeploymentCondition describes the state of a deployment at a certain point.
+ + +Field | +Description | +
---|---|
lastTransitionTime Time |
+Last time the condition transitioned from one status to another. | +
lastUpdateTime Time |
+The last time this condition was updated. | +
message string |
+A human readable message indicating details about the transition. | +
reason string |
+The reason for the condition's last transition. | +
status string |
+Status of the condition, one of True, False, Unknown. | +
type string |
+Type of deployment condition. | +
Group | +Version | +Kind | +
---|---|---|
apps | +v1beta2 | +DeploymentCondition | +
DeploymentCondition describes the state of a deployment at a certain point.
+ + +Field | +Description | +
---|---|
lastTransitionTime Time |
+Last time the condition transitioned from one status to another. | +
lastUpdateTime Time |
+The last time this condition was updated. | +
message string |
+A human readable message indicating details about the transition. | +
reason string |
+The reason for the condition's last transition. | +
status string |
+Status of the condition, one of True, False, Unknown. | +
type string |
+Type of deployment condition. | +
Group | +Version | +Kind | +
---|---|---|
autoscaling | +v2beta1 | +HorizontalPodAutoscaler | +
HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec HorizontalPodAutoscalerSpec |
+spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. | +
status HorizontalPodAutoscalerStatus |
+status is the current information about the autoscaler. | +
Field | +Description | +
---|---|
maxReplicas integer |
+maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas. | +
metrics MetricSpec array |
+metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond. | +
minReplicas integer |
+minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. | +
scaleTargetRef CrossVersionObjectReference |
+scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count. | +
Field | +Description | +
---|---|
conditions HorizontalPodAutoscalerCondition array |
+conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met. | +
currentMetrics MetricStatus array |
+currentMetrics is the last read state of the metrics used by this autoscaler. | +
currentReplicas integer |
+currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler. | +
desiredReplicas integer |
+desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler. | +
lastScaleTime Time |
+lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods, used by the autoscaler to control how often the number of pods is changed. | +
observedGeneration integer |
+observedGeneration is the most recent generation observed by this autoscaler. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items HorizontalPodAutoscaler array |
+items is the list of horizontal pod autoscaler objects. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+metadata is the standard list metadata. | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a HorizontalPodAutoscaler
+POST /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body HorizontalPodAutoscaler |
++ |
Code | +Description | +
---|---|
200 HorizontalPodAutoscaler |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified HorizontalPodAutoscaler
+PATCH /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
Parameter | +Description | +
---|---|
name | +name of the HorizontalPodAutoscaler | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 HorizontalPodAutoscaler |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified HorizontalPodAutoscaler
+PUT /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
Parameter | +Description | +
---|---|
name | +name of the HorizontalPodAutoscaler | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body HorizontalPodAutoscaler |
++ |
Code | +Description | +
---|---|
200 HorizontalPodAutoscaler |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a HorizontalPodAutoscaler
+DELETE /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
Parameter | +Description | +
---|---|
name | +name of the HorizontalPodAutoscaler | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of HorizontalPodAutoscaler
+DELETE /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified HorizontalPodAutoscaler
+GET /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
Parameter | +Description | +
---|---|
name | +name of the HorizontalPodAutoscaler | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 HorizontalPodAutoscaler |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind HorizontalPodAutoscaler
+GET /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 HorizontalPodAutoscalerList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind HorizontalPodAutoscaler
+GET /apis/autoscaling/v2beta1/horizontalpodautoscalers
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 HorizontalPodAutoscalerList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind HorizontalPodAutoscaler
+GET /apis/autoscaling/v2beta1/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}
Parameter | +Description | +
---|---|
name | +name of the HorizontalPodAutoscaler | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of HorizontalPodAutoscaler
+GET /apis/autoscaling/v2beta1/watch/namespaces/{namespace}/horizontalpodautoscalers
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of HorizontalPodAutoscaler
+GET /apis/autoscaling/v2beta1/watch/horizontalpodautoscalers
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update status of the specified HorizontalPodAutoscaler
+PATCH /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
Parameter | +Description | +
---|---|
name | +name of the HorizontalPodAutoscaler | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 HorizontalPodAutoscaler |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read status of the specified HorizontalPodAutoscaler
+GET /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
Parameter | +Description | +
---|---|
name | +name of the HorizontalPodAutoscaler | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 HorizontalPodAutoscaler |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified HorizontalPodAutoscaler
+PUT /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
Parameter | +Description | +
---|---|
name | +name of the HorizontalPodAutoscaler | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body HorizontalPodAutoscaler |
++ |
Code | +Description | +
---|---|
200 HorizontalPodAutoscaler |
+OK | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +IPBlock | +
IPBlock describes a particular CIDR (Ex. "192.168.1.1/24") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.
+ + +Field | +Description | +
---|---|
cidr string |
+CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24" | +
except string array |
+Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" Except values will be rejected if they are outside the CIDR range | +
Group | +Version | +Kind | +
---|---|---|
admissionregistration | +v1alpha1 | +Initializer | +
Initializer describes the name and the failure policy of an initializer, and what resources it applies to.
+ + +Field | +Description | +
---|---|
name string |
+Name is the identifier of the initializer. It will be added to the object that needs to be initialized. Name should be fully qualified, e.g., alwayspullimages.kubernetes.io, where "alwayspullimages" is the name of the webhook, and kubernetes.io is the name of the organization. Required | +
rules Rule array |
+Rules describes what resources/subresources the initializer cares about. The initializer cares about an operation if it matches any Rule. Rule.Resources must not include subresources. | +
Group | +Version | +Kind | +
---|---|---|
batch | +v2alpha1 | +JobTemplateSpec | +
JobTemplateSpec describes the data a Job should have when created from a template
+ + +Field | +Description | +
---|---|
metadata ObjectMeta |
+Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec JobSpec |
+Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
Group | +Version | +Kind | +
---|---|---|
authorization | +v1beta1 | +LocalSubjectAccessReview | +
LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking.
+Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
++ |
spec SubjectAccessReviewSpec |
+Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted. | +
status SubjectAccessReviewStatus |
+Status is filled in by the server and indicates whether the request is allowed or not | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a LocalSubjectAccessReview
+POST /apis/authorization.k8s.io/v1beta1/namespaces/{namespace}/localsubjectaccessreviews
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body LocalSubjectAccessReview |
++ |
Code | +Description | +
---|---|
200 LocalSubjectAccessReview |
+OK | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +NetworkPolicy | +
NetworkPolicy describes what network traffic is allowed for a set of Pods
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec NetworkPolicySpec |
+Specification of the desired behavior for this NetworkPolicy. | +
Field | +Description | +
---|---|
egress NetworkPolicyEgressRule array |
+List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8 | +
ingress NetworkPolicyIngressRule array |
+List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default). | +
podSelector LabelSelector |
+Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace. | +
policyTypes string array |
+List of rule types that the NetworkPolicy relates to. Valid options are Ingress, Egress, or Ingress,Egress. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an Egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8 | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items NetworkPolicy array |
+Items is a list of schema objects. | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a NetworkPolicy
+POST /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body NetworkPolicy |
++ |
Code | +Description | +
---|---|
200 NetworkPolicy |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified NetworkPolicy
+PATCH /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}
Parameter | +Description | +
---|---|
name | +name of the NetworkPolicy | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 NetworkPolicy |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified NetworkPolicy
+PUT /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}
Parameter | +Description | +
---|---|
name | +name of the NetworkPolicy | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body NetworkPolicy |
++ |
Code | +Description | +
---|---|
200 NetworkPolicy |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a NetworkPolicy
+DELETE /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}
Parameter | +Description | +
---|---|
name | +name of the NetworkPolicy | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of NetworkPolicy
+DELETE /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified NetworkPolicy
+GET /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}
Parameter | +Description | +
---|---|
name | +name of the NetworkPolicy | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 NetworkPolicy |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind NetworkPolicy
+GET /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 NetworkPolicyList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind NetworkPolicy
+GET /apis/extensions/v1beta1/networkpolicies
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 NetworkPolicyList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind NetworkPolicy
+GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies/{name}
Parameter | +Description | +
---|---|
name | +name of the NetworkPolicy | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of NetworkPolicy
+GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of NetworkPolicy
+GET /apis/extensions/v1beta1/watch/networkpolicies
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +NetworkPolicyEgressRule | +
NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8
+ + +Field | +Description | +
---|---|
ports NetworkPolicyPort array |
+List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list. | +
to NetworkPolicyPeer array |
+List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list. | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +NetworkPolicyIngressRule | +
This NetworkPolicyIngressRule matches traffic if and only if the traffic matches both ports AND from.
+ + +Field | +Description | +
---|---|
from NetworkPolicyPeer array |
+List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least on item, this rule allows traffic only if the traffic matches at least one item in the from list. | +
ports NetworkPolicyPort array |
+List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list. | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +NetworkPolicyPeer | +
Field | +Description | +
---|---|
ipBlock IPBlock |
+IPBlock defines policy on a particular IPBlock | +
namespaceSelector LabelSelector |
+Selects Namespaces using cluster scoped-labels. This matches all pods in all namespaces selected by this label selector. This field follows standard label selector semantics. If present but empty, this selector selects all namespaces. | +
podSelector LabelSelector |
+This is a label selector which selects Pods in this namespace. This field follows standard label selector semantics. If present but empty, this selector selects all pods in this namespace. | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +NetworkPolicyPort | +
Field | +Description | +
---|---|
port | +If specified, the port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched. | +
protocol string |
+Optional. The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP. | +
Group | +Version | +Kind | +
---|---|---|
authorization | +v1beta1 | +NonResourceAttributes | +
NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface
+ + +Field | +Description | +
---|---|
path string |
+Path is the URL path of the request | +
verb string |
+Verb is the standard HTTP verb | +
Group | +Version | +Kind | +
---|---|---|
authorization | +v1beta1 | +NonResourceRule | +
NonResourceRule holds information that describes a rule for the non-resource
+ + +Field | +Description | +
---|---|
nonResourceURLs string array |
+NonResourceURLs is a set of partial urls that a user should have access to. s are allowed, but only as the full, final step in the path. "" means all. | +
verbs string array |
+Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all. | +
Group | +Version | +Kind | +
---|---|---|
rbac | +v1beta1 | +PolicyRule | +
PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.
+ + +Field | +Description | +
---|---|
apiGroups string array |
+APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. | +
nonResourceURLs string array |
+NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both. | +
resourceNames string array |
+ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. | +
resources string array |
+Resources is a list of resources this rule applies to. ResourceAll represents all resources. | +
verbs string array |
+Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds. | +
Group | +Version | +Kind | +
---|---|---|
rbac | +v1alpha1 | +PolicyRule | +
PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.
+ + +Field | +Description | +
---|---|
apiGroups string array |
+APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. | +
nonResourceURLs string array |
+NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path This name is intentionally different than the internal type so that the DefaultConvert works nicely and because the ordering may be different. Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both. | +
resourceNames string array |
+ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. | +
resources string array |
+Resources is a list of resources this rule applies to. ResourceAll represents all resources. | +
verbs string array |
+Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds. | +
Group | +Version | +Kind | +
---|---|---|
apps | +v1beta2 | +ReplicaSet | +
ReplicaSet represents the configuration of a ReplicaSet.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
spec ReplicaSetSpec |
+Spec defines the specification of the desired behavior of the ReplicaSet. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
status ReplicaSetStatus |
+Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | +
Field | +Description | +
---|---|
minReadySeconds integer |
+Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) | +
replicas integer |
+Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller | +
selector LabelSelector |
+Selector is a label query over pods that should match the replica count. If the selector is empty, it is defaulted to the labels present on the pod template. Label keys and values that must match in order to be controlled by this replica set. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | +
template PodTemplateSpec |
+Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template | +
Field | +Description | +
---|---|
availableReplicas integer |
+The number of available replicas (ready for at least minReadySeconds) for this replica set. | +
conditions ReplicaSetCondition array patch type: merge patch merge key: type |
+Represents the latest available observations of a replica set's current state. | +
fullyLabeledReplicas integer |
+The number of pods that have labels matching the labels of the pod template of the replicaset. | +
observedGeneration integer |
+ObservedGeneration reflects the generation of the most recently observed ReplicaSet. | +
readyReplicas integer |
+The number of ready replicas for this replica set. | +
replicas integer |
+Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items ReplicaSet array |
+List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a ReplicaSet
+POST /apis/apps/v1beta2/namespaces/{namespace}/replicasets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ReplicaSet |
++ |
Code | +Description | +
---|---|
200 ReplicaSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified ReplicaSet
+PATCH /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}
Parameter | +Description | +
---|---|
name | +name of the ReplicaSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 ReplicaSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified ReplicaSet
+PUT /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}
Parameter | +Description | +
---|---|
name | +name of the ReplicaSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ReplicaSet |
++ |
Code | +Description | +
---|---|
200 ReplicaSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a ReplicaSet
+DELETE /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}
Parameter | +Description | +
---|---|
name | +name of the ReplicaSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of ReplicaSet
+DELETE /apis/apps/v1beta2/namespaces/{namespace}/replicasets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified ReplicaSet
+GET /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}
Parameter | +Description | +
---|---|
name | +name of the ReplicaSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 ReplicaSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind ReplicaSet
+GET /apis/apps/v1beta2/namespaces/{namespace}/replicasets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ReplicaSetList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind ReplicaSet
+GET /apis/apps/v1beta2/replicasets
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 ReplicaSetList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind ReplicaSet
+GET /apis/apps/v1beta2/watch/namespaces/{namespace}/replicasets/{name}
Parameter | +Description | +
---|---|
name | +name of the ReplicaSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of ReplicaSet
+GET /apis/apps/v1beta2/watch/namespaces/{namespace}/replicasets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of ReplicaSet
+GET /apis/apps/v1beta2/watch/replicasets
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update status of the specified ReplicaSet
+PATCH /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/status
Parameter | +Description | +
---|---|
name | +name of the ReplicaSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 ReplicaSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read status of the specified ReplicaSet
+GET /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/status
Parameter | +Description | +
---|---|
name | +name of the ReplicaSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 ReplicaSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified ReplicaSet
+PUT /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/status
Parameter | +Description | +
---|---|
name | +name of the ReplicaSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body ReplicaSet |
++ |
Code | +Description | +
---|---|
200 ReplicaSet |
+OK | +
Group | +Version | +Kind | +
---|---|---|
apps | +v1beta2 | +ReplicaSetCondition | +
ReplicaSetCondition describes the state of a replica set at a certain point.
+ + +Field | +Description | +
---|---|
lastTransitionTime Time |
+The last time the condition transitioned from one status to another. | +
message string |
+A human readable message indicating details about the transition. | +
reason string |
+The reason for the condition's last transition. | +
status string |
+Status of the condition, one of True, False, Unknown. | +
type string |
+Type of replica set condition. | +
Group | +Version | +Kind | +
---|---|---|
authorization | +v1beta1 | +ResourceAttributes | +
ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface
+ + +Field | +Description | +
---|---|
group string |
+Group is the API Group of the Resource. "*" means all. | +
name string |
+Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all. | +
namespace string |
+Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview | +
resource string |
+Resource is one of the existing resource types. "*" means all. | +
subresource string |
+Subresource is one of the existing resource types. "" means none. | +
verb string |
+Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. | +
version string |
+Version is the API Version of the Resource. "*" means all. | +
Group | +Version | +Kind | +
---|---|---|
authorization | +v1beta1 | +ResourceRule | +
ResourceRule is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
+ + +Field | +Description | +
---|---|
apiGroups string array |
+APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "*" means all. | +
resourceNames string array |
+ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. "*" means all. | +
resources string array |
+Resources is a list of resources this rule applies to. ResourceAll represents all resources. "*" means all. | +
verbs string array |
+Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all. | +
Group | +Version | +Kind | +
---|---|---|
rbac | +v1beta1 | +Role | +
Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. | +
rules PolicyRule array |
+Rules holds all the PolicyRules for this Role | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items Role array |
+Items is a list of Roles | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard object's metadata. | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a Role
+POST /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Role |
++ |
Code | +Description | +
---|---|
200 Role |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified Role
+PATCH /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}
Parameter | +Description | +
---|---|
name | +name of the Role | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 Role |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified Role
+PUT /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}
Parameter | +Description | +
---|---|
name | +name of the Role | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Role |
++ |
Code | +Description | +
---|---|
200 Role |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a Role
+DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}
Parameter | +Description | +
---|---|
name | +name of the Role | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of Role
+DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified Role
+GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}
Parameter | +Description | +
---|---|
name | +name of the Role | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 Role |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind Role
+GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 RoleList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind Role
+GET /apis/rbac.authorization.k8s.io/v1beta1/roles
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 RoleList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind Role
+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/roles/{name}
Parameter | +Description | +
---|---|
name | +name of the Role | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Role
+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/roles
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Role
+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/roles
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
rbac | +v1alpha1 | +Role | +
Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. | +
rules PolicyRule array |
+Rules holds all the PolicyRules for this Role | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items Role array |
+Items is a list of Roles | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard object's metadata. | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a Role
+POST /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Role |
++ |
Code | +Description | +
---|---|
200 Role |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified Role
+PATCH /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}
Parameter | +Description | +
---|---|
name | +name of the Role | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 Role |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified Role
+PUT /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}
Parameter | +Description | +
---|---|
name | +name of the Role | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Role |
++ |
Code | +Description | +
---|---|
200 Role |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a Role
+DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}
Parameter | +Description | +
---|---|
name | +name of the Role | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of Role
+DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified Role
+GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}
Parameter | +Description | +
---|---|
name | +name of the Role | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 Role |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind Role
+GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 RoleList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind Role
+GET /apis/rbac.authorization.k8s.io/v1alpha1/roles
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 RoleList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind Role
+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles/{name}
Parameter | +Description | +
---|---|
name | +name of the Role | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Role
+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of Role
+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/roles
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
rbac | +v1beta1 | +RoleBinding | +
RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. | +
roleRef RoleRef |
+RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. | +
subjects Subject array |
+Subjects holds references to the objects the role applies to. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items RoleBinding array |
+Items is a list of RoleBindings | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard object's metadata. | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a RoleBinding
+POST /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body RoleBinding |
++ |
Code | +Description | +
---|---|
200 RoleBinding |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified RoleBinding
+PATCH /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the RoleBinding | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 RoleBinding |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified RoleBinding
+PUT /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the RoleBinding | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body RoleBinding |
++ |
Code | +Description | +
---|---|
200 RoleBinding |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a RoleBinding
+DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the RoleBinding | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of RoleBinding
+DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the RoleBinding | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 RoleBinding |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 RoleBindingList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1beta1/rolebindings
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 RoleBindingList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/rolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the RoleBinding | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/rolebindings
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/rolebindings
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
rbac | +v1alpha1 | +RoleBinding | +
RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. | +
roleRef RoleRef |
+RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. | +
subjects Subject array |
+Subjects holds references to the objects the role applies to. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items RoleBinding array |
+Items is a list of RoleBindings | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard object's metadata. | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a RoleBinding
+POST /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body RoleBinding |
++ |
Code | +Description | +
---|---|
200 RoleBinding |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified RoleBinding
+PATCH /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the RoleBinding | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 RoleBinding |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified RoleBinding
+PUT /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the RoleBinding | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body RoleBinding |
++ |
Code | +Description | +
---|---|
200 RoleBinding |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a RoleBinding
+DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the RoleBinding | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of RoleBinding
+DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the RoleBinding | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 RoleBinding |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 RoleBindingList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1alpha1/rolebindings
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 RoleBindingList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/rolebindings/{name}
Parameter | +Description | +
---|---|
name | +name of the RoleBinding | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/rolebindings
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of RoleBinding
+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/rolebindings
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
rbac | +v1beta1 | +RoleRef | +
RoleRef contains information that points to the role being used
+ + +Field | +Description | +
---|---|
apiGroup string |
+APIGroup is the group for the resource being referenced | +
kind string |
+Kind is the type of resource being referenced | +
name string |
+Name is the name of resource being referenced | +
Group | +Version | +Kind | +
---|---|---|
rbac | +v1alpha1 | +RoleRef | +
RoleRef contains information that points to the role being used
+ + +Field | +Description | +
---|---|
apiGroup string |
+APIGroup is the group for the resource being referenced | +
kind string |
+Kind is the type of resource being referenced | +
name string |
+Name is the name of resource being referenced | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +RollbackConfig | +
DEPRECATED.
+ + +Field | +Description | +
---|---|
revision integer |
+The revision to rollback to. If set to 0, rollback to the last revision. | +
Group | +Version | +Kind | +
---|---|---|
apps | +v1beta2 | +RollingUpdateStatefulSetStrategy | +
RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.
+ + +Field | +Description | +
---|---|
partition integer |
+Partition indicates the ordinal at which the StatefulSet should be partitioned. Default value is 0. | +
Group | +Version | +Kind | +
---|---|---|
apps | +v1beta1 | +Scale | +
Scale represents a scaling request for a resource.
+Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata. | +
spec ScaleSpec |
+defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. | +
status ScaleStatus |
+current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only. | +
Field | +Description | +
---|---|
replicas integer |
+desired number of instances for the scaled object. | +
Field | +Description | +
---|---|
replicas integer |
+actual number of observed instances of the scaled object. | +
selector object |
+label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors | +
targetSelector string |
+label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | +
Group | +Version | +Kind | +
---|---|---|
extensions | +v1beta1 | +Scale | +
represents a scaling request for a resource.
+Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata. | +
spec ScaleSpec |
+defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. | +
status ScaleStatus |
+current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only. | +
Field | +Description | +
---|---|
replicas integer |
+desired number of instances for the scaled object. | +
Field | +Description | +
---|---|
replicas integer |
+actual number of observed instances of the scaled object. | +
selector object |
+label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors | +
targetSelector string |
+label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | +
Group | +Version | +Kind | +
---|---|---|
apps | +v1beta2 | +Scale | +
Scale represents a scaling request for a resource.
+Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata. | +
spec ScaleSpec |
+defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. | +
status ScaleStatus |
+current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only. | +
Field | +Description | +
---|---|
replicas integer |
+desired number of instances for the scaled object. | +
Field | +Description | +
---|---|
replicas integer |
+actual number of observed instances of the scaled object. | +
selector object |
+label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors | +
targetSelector string |
+label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | +
Group | +Version | +Kind | +
---|---|---|
authorization | +v1beta1 | +SelfSubjectAccessReview | +
SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action
+Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
++ |
spec SelfSubjectAccessReviewSpec |
+Spec holds information about the request being evaluated. user and groups must be empty | +
status SubjectAccessReviewStatus |
+Status is filled in by the server and indicates whether the request is allowed or not | +
Field | +Description | +
---|---|
nonResourceAttributes NonResourceAttributes |
+NonResourceAttributes describes information for a non-resource access request | +
resourceAttributes ResourceAttributes |
+ResourceAuthorizationAttributes describes information for a resource access request | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a SelfSubjectAccessReview
+POST /apis/authorization.k8s.io/v1beta1/selfsubjectaccessreviews
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body SelfSubjectAccessReview |
++ |
Code | +Description | +
---|---|
200 SelfSubjectAccessReview |
+OK | +
Group | +Version | +Kind | +
---|---|---|
authorization | +v1beta1 | +SelfSubjectRulesReview | +
SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server.
+Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
++ |
spec SelfSubjectRulesReviewSpec |
+Spec holds information about the request being evaluated. | +
status SubjectRulesReviewStatus |
+Status is filled in by the server and indicates the set of actions a user can perform. | +
Field | +Description | +
---|---|
namespace string |
+Namespace to evaluate rules for. Required. | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a SelfSubjectRulesReview
+POST /apis/authorization.k8s.io/v1beta1/selfsubjectrulesreviews
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body SelfSubjectRulesReview |
++ |
Code | +Description | +
---|---|
200 SelfSubjectRulesReview |
+OK | +
Group | +Version | +Kind | +
---|---|---|
admissionregistration | +v1alpha1 | +ServiceReference | +
ServiceReference holds a reference to Service.legacy.k8s.io
+ + +Field | +Description | +
---|---|
name string |
+Name is the name of the service Required | +
namespace string |
+Namespace is the namespace of the service Required | +
Group | +Version | +Kind | +
---|---|---|
apps | +v1beta2 | +StatefulSet | +
StatefulSet represents a set of pods with consistent identities. Identities are defined as:
+Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
++ |
spec StatefulSetSpec |
+Spec defines the desired identities of pods in this set. | +
status StatefulSetStatus |
+Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time. | +
Field | +Description | +
---|---|
podManagementPolicy string |
+podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is OrderedReady , where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once. |
+
replicas integer |
+replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1. | +
revisionHistoryLimit integer |
+revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10. | +
selector LabelSelector |
+selector is a label query over pods that should match the replica count. If empty, defaulted to labels on the pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | +
serviceName string |
+serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller. | +
template PodTemplateSpec |
+template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet. | +
updateStrategy StatefulSetUpdateStrategy |
+updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. | +
volumeClaimTemplates PersistentVolumeClaim array |
+volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name. | +
Field | +Description | +
---|---|
collisionCount integer |
+collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision. | +
currentReplicas integer |
+currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision. | +
currentRevision string |
+currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas). | +
observedGeneration integer |
+observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server. | +
readyReplicas integer |
+readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition. | +
replicas integer |
+replicas is the number of Pods created by the StatefulSet controller. | +
updateRevision string |
+updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas) | +
updatedReplicas integer |
+updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items StatefulSet array |
++ |
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
++ |
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a StatefulSet
+POST /apis/apps/v1beta2/namespaces/{namespace}/statefulsets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body StatefulSet |
++ |
Code | +Description | +
---|---|
200 StatefulSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified StatefulSet
+PATCH /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}
Parameter | +Description | +
---|---|
name | +name of the StatefulSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 StatefulSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified StatefulSet
+PUT /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}
Parameter | +Description | +
---|---|
name | +name of the StatefulSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body StatefulSet |
++ |
Code | +Description | +
---|---|
200 StatefulSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a StatefulSet
+DELETE /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}
Parameter | +Description | +
---|---|
name | +name of the StatefulSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of StatefulSet
+DELETE /apis/apps/v1beta2/namespaces/{namespace}/statefulsets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified StatefulSet
+GET /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}
Parameter | +Description | +
---|---|
name | +name of the StatefulSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 StatefulSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind StatefulSet
+GET /apis/apps/v1beta2/namespaces/{namespace}/statefulsets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 StatefulSetList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind StatefulSet
+GET /apis/apps/v1beta2/statefulsets
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 StatefulSetList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind StatefulSet
+GET /apis/apps/v1beta2/watch/namespaces/{namespace}/statefulsets/{name}
Parameter | +Description | +
---|---|
name | +name of the StatefulSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of StatefulSet
+GET /apis/apps/v1beta2/watch/namespaces/{namespace}/statefulsets
Parameter | +Description | +
---|---|
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of StatefulSet
+GET /apis/apps/v1beta2/watch/statefulsets
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update status of the specified StatefulSet
+PATCH /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/status
Parameter | +Description | +
---|---|
name | +name of the StatefulSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 StatefulSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read status of the specified StatefulSet
+GET /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/status
Parameter | +Description | +
---|---|
name | +name of the StatefulSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Code | +Description | +
---|---|
200 StatefulSet |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace status of the specified StatefulSet
+PUT /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/status
Parameter | +Description | +
---|---|
name | +name of the StatefulSet | +
namespace | +object name and auth scope, such as for teams and projects | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body StatefulSet |
++ |
Code | +Description | +
---|---|
200 StatefulSet |
+OK | +
Group | +Version | +Kind | +
---|---|---|
apps | +v1beta2 | +StatefulSetUpdateStrategy | +
StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.
+ + +Field | +Description | +
---|---|
rollingUpdate RollingUpdateStatefulSetStrategy |
+RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType. | +
type string |
+Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate. | +
Group | +Version | +Kind | +
---|---|---|
storage | +v1beta1 | +StorageClass | +
StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.
+StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.
+ + +Field | +Description | +
---|---|
allowVolumeExpansion boolean |
+AllowVolumeExpansion shows whether the storage class allow volume expand | +
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
+Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
mountOptions string array |
+Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid. | +
parameters object |
+Parameters holds the parameters for the provisioner that should create volumes of this storage class. | +
provisioner string |
+Provisioner indicates the type of the provisioner. | +
reclaimPolicy string |
+Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete. | +
Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
items StorageClass array |
+Items is the list of StorageClasses | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ListMeta |
+Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a StorageClass
+POST /apis/storage.k8s.io/v1beta1/storageclasses
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body StorageClass |
++ |
Code | +Description | +
---|---|
200 StorageClass |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+partially update the specified StorageClass
+PATCH /apis/storage.k8s.io/v1beta1/storageclasses/{name}
Parameter | +Description | +
---|---|
name | +name of the StorageClass | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body Patch |
++ |
Code | +Description | +
---|---|
200 StorageClass |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+replace the specified StorageClass
+PUT /apis/storage.k8s.io/v1beta1/storageclasses/{name}
Parameter | +Description | +
---|---|
name | +name of the StorageClass | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body StorageClass |
++ |
Code | +Description | +
---|---|
200 StorageClass |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete a StorageClass
+DELETE /apis/storage.k8s.io/v1beta1/storageclasses/{name}
Parameter | +Description | +
---|---|
name | +name of the StorageClass | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
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. | +
orphanDependents | +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +
propagationPolicy | +Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | +
Parameter | +Description | +
---|---|
body DeleteOptions |
++ |
Code | +Description | +
---|---|
200 Status |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+delete collection of StorageClass
+DELETE /apis/storage.k8s.io/v1beta1/storageclasses
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 Status |
+OK | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+read the specified StorageClass
+GET /apis/storage.k8s.io/v1beta1/storageclasses/{name}
Parameter | +Description | +
---|---|
name | +name of the StorageClass | +
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
exact | +Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | +
export | +Should this value be exported. Export strips fields that a user can not specify. | +
Code | +Description | +
---|---|
200 StorageClass |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+list or watch objects of kind StorageClass
+GET /apis/storage.k8s.io/v1beta1/storageclasses
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 StorageClassList |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch changes to an object of kind StorageClass
+GET /apis/storage.k8s.io/v1beta1/watch/storageclasses/{name}
Parameter | +Description | +
---|---|
name | +name of the StorageClass | +
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
+++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+watch individual changes to a list of StorageClass
+GET /apis/storage.k8s.io/v1beta1/watch/storageclasses
Parameter | +Description | +
---|---|
continue | +The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | +
fieldSelector | +A selector to restrict the list of returned objects by their fields. Defaults to everything. | +
includeUninitialized | +If true, partially initialized resources are included in the response. | +
labelSelector | +A selector to restrict the list of returned objects by their labels. Defaults to everything. | +
limit | +limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
+
pretty | +If 'true', then the output is pretty printed. | +
resourceVersion | +When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | +
timeoutSeconds | +Timeout for the list/watch call. | +
watch | +Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | +
Code | +Description | +
---|---|
200 WatchEvent |
+OK | +
Group | +Version | +Kind | +
---|---|---|
rbac | +v1beta1 | +Subject | +
Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.
+ + +Field | +Description | +
---|---|
apiGroup string |
+APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects. | +
kind string |
+Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error. | +
name string |
+Name of the object being referenced. | +
namespace string |
+Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error. | +
Group | +Version | +Kind | +
---|---|---|
rbac | +v1alpha1 | +Subject | +
Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.
+ + +Field | +Description | +
---|---|
apiVersion string |
+APIVersion holds the API group and version of the referenced subject. Defaults to "v1" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io/v1alpha1" for User and Group subjects. | +
kind string |
+Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error. | +
name string |
+Name of the object being referenced. | +
namespace string |
+Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error. | +
Group | +Version | +Kind | +
---|---|---|
authorization | +v1beta1 | +SubjectAccessReview | +
SubjectAccessReview checks whether or not a user or group can perform an action.
+Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
++ |
spec SubjectAccessReviewSpec |
+Spec holds information about the request being evaluated | +
status SubjectAccessReviewStatus |
+Status is filled in by the server and indicates whether the request is allowed or not | +
Field | +Description | +
---|---|
extra object |
+Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here. | +
group string array |
+Groups is the groups you're testing for. | +
nonResourceAttributes NonResourceAttributes |
+NonResourceAttributes describes information for a non-resource access request | +
resourceAttributes ResourceAttributes |
+ResourceAuthorizationAttributes describes information for a resource access request | +
uid string |
+UID information about the requesting user. | +
user string |
+User is the user you're testing for. If you specify "User" but not "Group", then is it interpreted as "What if User were not a member of any groups | +
Field | +Description | +
---|---|
allowed boolean |
+Allowed is required. True if the action would be allowed, false otherwise. | +
evaluationError string |
+EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request. | +
reason string |
+Reason is optional. It indicates why a request was allowed or denied. | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a SubjectAccessReview
+POST /apis/authorization.k8s.io/v1beta1/subjectaccessreviews
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body SubjectAccessReview |
++ |
Code | +Description | +
---|---|
200 SubjectAccessReview |
+OK | +
Group | +Version | +Kind | +
---|---|---|
authorization | +v1beta1 | +SubjectRulesReviewStatus | +
SubjectRulesReviewStatus contains the result of a rules check. This check can be incomplete depending on the set of authorizers the server is configured with and any errors experienced during evaluation. Because authorization rules are additive, if a rule appears in a list it's safe to assume the subject has that permission, even if that list is incomplete.
+ + +Field | +Description | +
---|---|
evaluationError string |
+EvaluationError can appear in combination with Rules. It indicates an error occurred during rule evaluation, such as an authorizer that doesn't support rule evaluation, and that ResourceRules and/or NonResourceRules may be incomplete. | +
incomplete boolean |
+Incomplete is true when the rules returned by this call are incomplete. This is most commonly encountered when an authorizer, such as an external authorizer, doesn't support rules evaluation. | +
nonResourceRules NonResourceRule array |
+NonResourceRules is the list of actions the subject is allowed to perform on non-resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete. | +
resourceRules ResourceRule array |
+ResourceRules is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete. | +
Group | +Version | +Kind | +
---|---|---|
authentication | +v1beta1 | +TokenReview | +
TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver.
+Field | +Description | +
---|---|
apiVersion string |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources | +
kind string |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | +
metadata ObjectMeta |
++ |
spec TokenReviewSpec |
+Spec holds information about the request being evaluated | +
status TokenReviewStatus |
+Status is filled in by the server and indicates whether the request can be authenticated. | +
Field | +Description | +
---|---|
token string |
+Token is the opaque bearer token. | +
Field | +Description | +
---|---|
authenticated boolean |
+Authenticated indicates that the token was associated with a known user. | +
error string |
+Error indicates that the token couldn't be checked | +
user UserInfo |
+User is the UserInfo associated with the provided token. | +
See supported operations below...
++++
kubectl
Command
+Coming Soon
+
++++
curl
Command (requireskubectl proxy
to be running)
+Coming Soon
+
+++Output
+
+Coming Soon
+
+++Response Body
+
+Coming Soon
+
+create a TokenReview
+POST /apis/authentication.k8s.io/v1beta1/tokenreviews
Parameter | +Description | +
---|---|
pretty | +If 'true', then the output is pretty printed. | +
Parameter | +Description | +
---|---|
body TokenReview |
++ |
Code | +Description | +
---|---|
200 TokenReview |
+OK | +
Group | +Version | +Kind | +
---|---|---|
authentication | +v1beta1 | +UserInfo | +
UserInfo holds the information about the user needed to implement the user.Info interface.
+ + +Field | +Description | +
---|---|
extra object |
+Any additional information provided by the authenticator. | +
groups string array |
+The names of groups this user is a part of. | +
uid string |
+A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs. | +
username string |
+The name that uniquely identifies this user among all active users. | +
\n' + bdquote + '\n'; + } else { + return '
\n' + quote + '\n'; + } + }; + + renderer.code = function (code, lang, escaped) { + var bdocGroup = lang.substring(0, lang.indexOf('_')); + var bdocTab = bdocGroup.split(':')[1]; + var hlang = lang.substring(lang.indexOf('_')+1); + + if (renderer.options.highlight) { + var out = renderer.options.highlight(code, hlang); + if (out !== null && out !== code) { + escaped = true; + code = out; + } + } + + var tabLang = hlang ? hlang : 'generic'; + if (codeTabs.indexOf(bdocTab) === -1) { + codeTabs.push(bdocTab); + } + + if (!hlang) { + return '
'
+ + (escaped ? code : escape(code, true))
+ + '\n
';
+ }
+
+ return ''
+ + (escaped ? code : escape(code, true))
+ + '\n
\n';
+ };
+ };
+
+ if (typeof module !== 'undefined' && typeof exports === 'object') {
+ module.exports = brodocDec;
+ } else if (typeof define === 'function' && define.amd) {
+ define(function() { return brodocDec; });
+ } else {
+ this.brodocDec = brodocDec;
+ }
+ brodocDec.navIds = navIds;
+ brodocDec.codeTabs = codeTabs;
+ return brodocDec;
+
+}).call(function() {
+ return this || (typeof window !== 'undefined' ? window : global);
+}());
\ No newline at end of file
diff --git a/docs/api-reference/v1.8/navData.js b/docs/api-reference/v1.8/navData.js
new file mode 100644
index 0000000000000..9d7ca3ddd4596
--- /dev/null
+++ b/docs/api-reference/v1.8/navData.js
@@ -0,0 +1 @@
+(function(){navData = {"toc":[{"section":"userinfo-v1beta1-authentication","subsections":[]},{"section":"tokenreview-v1beta1-authentication","subsections":[{"section":"-strong-write-operations-strong--852","subsections":[{"section":"create-853"}]}]},{"section":"subjectrulesreviewstatus-v1beta1-authorization","subsections":[]},{"section":"subjectaccessreview-v1beta1-authorization","subsections":[{"section":"-strong-write-operations-strong--850","subsections":[{"section":"create-851"}]}]},{"section":"subject-v1alpha1-rbac","subsections":[]},{"section":"subject-v1beta1-rbac","subsections":[]},{"section":"storageclass-v1beta1-storage","subsections":[{"section":"-strong-read-operations-strong--845","subsections":[{"section":"watch-list-849"},{"section":"watch-848"},{"section":"list-847"},{"section":"read-846"}]},{"section":"-strong-write-operations-strong--839","subsections":[{"section":"delete-collection-844"},{"section":"delete-843"},{"section":"replace-842"},{"section":"patch-841"},{"section":"create-840"}]}]},{"section":"statefulsetupdatestrategy-v1beta2-apps","subsections":[]},{"section":"statefulset-v1beta2-apps","subsections":[{"section":"-strong-status-operations-strong--835","subsections":[{"section":"replace-status-838"},{"section":"read-status-837"},{"section":"patch-status-836"}]},{"section":"-strong-read-operations-strong--828","subsections":[{"section":"watch-list-all-namespaces-834"},{"section":"watch-list-833"},{"section":"watch-832"},{"section":"list-all-namespaces-831"},{"section":"list-830"},{"section":"read-829"}]},{"section":"-strong-write-operations-strong--822","subsections":[{"section":"delete-collection-827"},{"section":"delete-826"},{"section":"replace-825"},{"section":"patch-824"},{"section":"create-823"}]}]},{"section":"servicereference-v1alpha1-admissionregistration","subsections":[]},{"section":"selfsubjectrulesreview-v1beta1-authorization","subsections":[{"section":"-strong-write-operations-strong--820","subsections":[{"section":"create-821"}]}]},{"section":"selfsubjectaccessreview-v1beta1-authorization","subsections":[{"section":"-strong-write-operations-strong--818","subsections":[{"section":"create-819"}]}]},{"section":"scale-v1beta2-apps","subsections":[]},{"section":"scale-v1beta1-extensions","subsections":[]},{"section":"scale-v1beta1-apps","subsections":[]},{"section":"rollingupdatestatefulsetstrategy-v1beta2-apps","subsections":[]},{"section":"rollbackconfig-v1beta1-extensions","subsections":[]},{"section":"roleref-v1alpha1-rbac","subsections":[]},{"section":"roleref-v1beta1-rbac","subsections":[]},{"section":"rolebinding-v1alpha1-rbac","subsections":[{"section":"-strong-read-operations-strong--811","subsections":[{"section":"watch-list-all-namespaces-817"},{"section":"watch-list-816"},{"section":"watch-815"},{"section":"list-all-namespaces-814"},{"section":"list-813"},{"section":"read-812"}]},{"section":"-strong-write-operations-strong--805","subsections":[{"section":"delete-collection-810"},{"section":"delete-809"},{"section":"replace-808"},{"section":"patch-807"},{"section":"create-806"}]}]},{"section":"rolebinding-v1beta1-rbac","subsections":[{"section":"-strong-read-operations-strong--798","subsections":[{"section":"watch-list-all-namespaces-804"},{"section":"watch-list-803"},{"section":"watch-802"},{"section":"list-all-namespaces-801"},{"section":"list-800"},{"section":"read-799"}]},{"section":"-strong-write-operations-strong--792","subsections":[{"section":"delete-collection-797"},{"section":"delete-796"},{"section":"replace-795"},{"section":"patch-794"},{"section":"create-793"}]}]},{"section":"role-v1alpha1-rbac","subsections":[{"section":"-strong-read-operations-strong--785","subsections":[{"section":"watch-list-all-namespaces-791"},{"section":"watch-list-790"},{"section":"watch-789"},{"section":"list-all-namespaces-788"},{"section":"list-787"},{"section":"read-786"}]},{"section":"-strong-write-operations-strong--779","subsections":[{"section":"delete-collection-784"},{"section":"delete-783"},{"section":"replace-782"},{"section":"patch-781"},{"section":"create-780"}]}]},{"section":"role-v1beta1-rbac","subsections":[{"section":"-strong-read-operations-strong--772","subsections":[{"section":"watch-list-all-namespaces-778"},{"section":"watch-list-777"},{"section":"watch-776"},{"section":"list-all-namespaces-775"},{"section":"list-774"},{"section":"read-773"}]},{"section":"-strong-write-operations-strong--766","subsections":[{"section":"delete-collection-771"},{"section":"delete-770"},{"section":"replace-769"},{"section":"patch-768"},{"section":"create-767"}]}]},{"section":"resourcerule-v1beta1-authorization","subsections":[]},{"section":"resourceattributes-v1beta1-authorization","subsections":[]},{"section":"replicasetcondition-v1beta2-apps","subsections":[]},{"section":"replicaset-v1beta2-apps","subsections":[{"section":"-strong-status-operations-strong--762","subsections":[{"section":"replace-status-765"},{"section":"read-status-764"},{"section":"patch-status-763"}]},{"section":"-strong-read-operations-strong--755","subsections":[{"section":"watch-list-all-namespaces-761"},{"section":"watch-list-760"},{"section":"watch-759"},{"section":"list-all-namespaces-758"},{"section":"list-757"},{"section":"read-756"}]},{"section":"-strong-write-operations-strong--749","subsections":[{"section":"delete-collection-754"},{"section":"delete-753"},{"section":"replace-752"},{"section":"patch-751"},{"section":"create-750"}]}]},{"section":"policyrule-v1alpha1-rbac","subsections":[]},{"section":"policyrule-v1beta1-rbac","subsections":[]},{"section":"nonresourcerule-v1beta1-authorization","subsections":[]},{"section":"nonresourceattributes-v1beta1-authorization","subsections":[]},{"section":"networkpolicyport-v1beta1-extensions","subsections":[]},{"section":"networkpolicypeer-v1beta1-extensions","subsections":[]},{"section":"networkpolicyingressrule-v1beta1-extensions","subsections":[]},{"section":"networkpolicyegressrule-v1beta1-extensions","subsections":[]},{"section":"networkpolicy-v1beta1-extensions","subsections":[{"section":"-strong-read-operations-strong--742","subsections":[{"section":"watch-list-all-namespaces-748"},{"section":"watch-list-747"},{"section":"watch-746"},{"section":"list-all-namespaces-745"},{"section":"list-744"},{"section":"read-743"}]},{"section":"-strong-write-operations-strong--736","subsections":[{"section":"delete-collection-741"},{"section":"delete-740"},{"section":"replace-739"},{"section":"patch-738"},{"section":"create-737"}]}]},{"section":"localsubjectaccessreview-v1beta1-authorization","subsections":[{"section":"-strong-write-operations-strong--734","subsections":[{"section":"create-735"}]}]},{"section":"jobtemplatespec-v2alpha1-batch","subsections":[]},{"section":"initializer-v1alpha1-admissionregistration","subsections":[]},{"section":"ipblock-v1beta1-extensions","subsections":[]},{"section":"horizontalpodautoscaler-v2beta1-autoscaling","subsections":[{"section":"-strong-status-operations-strong--730","subsections":[{"section":"replace-status-733"},{"section":"read-status-732"},{"section":"patch-status-731"}]},{"section":"-strong-read-operations-strong--723","subsections":[{"section":"watch-list-all-namespaces-729"},{"section":"watch-list-728"},{"section":"watch-727"},{"section":"list-all-namespaces-726"},{"section":"list-725"},{"section":"read-724"}]},{"section":"-strong-write-operations-strong--717","subsections":[{"section":"delete-collection-722"},{"section":"delete-721"},{"section":"replace-720"},{"section":"patch-719"},{"section":"create-718"}]}]},{"section":"deploymentcondition-v1beta2-apps","subsections":[]},{"section":"deploymentcondition-v1beta1-extensions","subsections":[]},{"section":"deployment-v1beta2-apps","subsections":[{"section":"-strong-status-operations-strong--713","subsections":[{"section":"replace-status-716"},{"section":"read-status-715"},{"section":"patch-status-714"}]},{"section":"-strong-read-operations-strong--706","subsections":[{"section":"watch-list-all-namespaces-712"},{"section":"watch-list-711"},{"section":"watch-710"},{"section":"list-all-namespaces-709"},{"section":"list-708"},{"section":"read-707"}]},{"section":"-strong-write-operations-strong--700","subsections":[{"section":"delete-collection-705"},{"section":"delete-704"},{"section":"replace-703"},{"section":"patch-702"},{"section":"create-701"}]}]},{"section":"deployment-v1beta1-extensions","subsections":[{"section":"-strong-status-operations-strong--696","subsections":[{"section":"replace-status-699"},{"section":"read-status-698"},{"section":"patch-status-697"}]},{"section":"-strong-read-operations-strong--689","subsections":[{"section":"watch-list-all-namespaces-695"},{"section":"watch-list-694"},{"section":"watch-693"},{"section":"list-all-namespaces-692"},{"section":"list-691"},{"section":"read-690"}]},{"section":"-strong-write-operations-strong--683","subsections":[{"section":"delete-collection-688"},{"section":"delete-687"},{"section":"replace-686"},{"section":"patch-685"},{"section":"create-684"}]}]},{"section":"daemonsetupdatestrategy-v1beta2-apps","subsections":[]},{"section":"daemonset-v1beta2-apps","subsections":[{"section":"-strong-status-operations-strong--679","subsections":[{"section":"replace-status-682"},{"section":"read-status-681"},{"section":"patch-status-680"}]},{"section":"-strong-read-operations-strong--672","subsections":[{"section":"watch-list-all-namespaces-678"},{"section":"watch-list-677"},{"section":"watch-676"},{"section":"list-all-namespaces-675"},{"section":"list-674"},{"section":"read-673"}]},{"section":"-strong-write-operations-strong--666","subsections":[{"section":"delete-collection-671"},{"section":"delete-670"},{"section":"replace-669"},{"section":"patch-668"},{"section":"create-667"}]}]},{"section":"crossversionobjectreference-v2beta1-autoscaling","subsections":[]},{"section":"cronjob-v2alpha1-batch","subsections":[{"section":"-strong-status-operations-strong--662","subsections":[{"section":"replace-status-665"},{"section":"read-status-664"},{"section":"patch-status-663"}]},{"section":"-strong-read-operations-strong--655","subsections":[{"section":"watch-list-all-namespaces-661"},{"section":"watch-list-660"},{"section":"watch-659"},{"section":"list-all-namespaces-658"},{"section":"list-657"},{"section":"read-656"}]},{"section":"-strong-write-operations-strong--649","subsections":[{"section":"delete-collection-654"},{"section":"delete-653"},{"section":"replace-652"},{"section":"patch-651"},{"section":"create-650"}]}]},{"section":"controllerrevision-v1beta2-apps","subsections":[{"section":"-strong-read-operations-strong--642","subsections":[{"section":"watch-list-all-namespaces-648"},{"section":"watch-list-647"},{"section":"watch-646"},{"section":"list-all-namespaces-645"},{"section":"list-644"},{"section":"read-643"}]},{"section":"-strong-write-operations-strong--636","subsections":[{"section":"delete-collection-641"},{"section":"delete-640"},{"section":"replace-639"},{"section":"patch-638"},{"section":"create-637"}]}]},{"section":"clusterrolebinding-v1alpha1-rbac","subsections":[{"section":"-strong-read-operations-strong--631","subsections":[{"section":"watch-list-635"},{"section":"watch-634"},{"section":"list-633"},{"section":"read-632"}]},{"section":"-strong-write-operations-strong--625","subsections":[{"section":"delete-collection-630"},{"section":"delete-629"},{"section":"replace-628"},{"section":"patch-627"},{"section":"create-626"}]}]},{"section":"clusterrolebinding-v1beta1-rbac","subsections":[{"section":"-strong-read-operations-strong--620","subsections":[{"section":"watch-list-624"},{"section":"watch-623"},{"section":"list-622"},{"section":"read-621"}]},{"section":"-strong-write-operations-strong--614","subsections":[{"section":"delete-collection-619"},{"section":"delete-618"},{"section":"replace-617"},{"section":"patch-616"},{"section":"create-615"}]}]},{"section":"clusterrole-v1alpha1-rbac","subsections":[{"section":"-strong-read-operations-strong--609","subsections":[{"section":"watch-list-613"},{"section":"watch-612"},{"section":"list-611"},{"section":"read-610"}]},{"section":"-strong-write-operations-strong--603","subsections":[{"section":"delete-collection-608"},{"section":"delete-607"},{"section":"replace-606"},{"section":"patch-605"},{"section":"create-604"}]}]},{"section":"clusterrole-v1beta1-rbac","subsections":[{"section":"-strong-read-operations-strong--598","subsections":[{"section":"watch-list-602"},{"section":"watch-601"},{"section":"list-600"},{"section":"read-599"}]},{"section":"-strong-write-operations-strong--592","subsections":[{"section":"delete-collection-597"},{"section":"delete-596"},{"section":"replace-595"},{"section":"patch-594"},{"section":"create-593"}]}]},{"section":"-strong-old-api-versions-strong-","subsections":[]},{"section":"-strong-definitions-strong-","subsections":[{"section":"weightedpodaffinityterm-v1-core"},{"section":"watchevent-v1-meta"},{"section":"vspherevirtualdiskvolumesource-v1-core"},{"section":"volumeprojection-v1-core"},{"section":"volumemount-v1-core"},{"section":"userinfo-v1-authentication"},{"section":"toleration-v1-core"},{"section":"time-v1-meta"},{"section":"taint-v1-core"},{"section":"tcpsocketaction-v1-core"},{"section":"supplementalgroupsstrategyoptions-v1beta1-extensions"},{"section":"subjectrulesreviewstatus-v1-authorization"},{"section":"subject-v1-rbac"},{"section":"storageosvolumesource-v1-core"},{"section":"storageospersistentvolumesource-v1-core"},{"section":"statusdetails-v1-meta"},{"section":"statuscause-v1-meta"},{"section":"status-v1-meta"},{"section":"statefulsetupdatestrategy-v1beta1-apps"},{"section":"sessionaffinityconfig-v1-core"},{"section":"servicereference-v1beta1-apiregistration"},{"section":"serviceport-v1-core"},{"section":"serveraddressbyclientcidr-v1-meta"},{"section":"securitycontext-v1-core"},{"section":"secretvolumesource-v1-core"},{"section":"secretreference-v1-core"},{"section":"secretprojection-v1-core"},{"section":"secretkeyselector-v1-core"},{"section":"secretenvsource-v1-core"},{"section":"scaleiovolumesource-v1-core"},{"section":"scale-v1-autoscaling"},{"section":"selinuxstrategyoptions-v1beta1-extensions"},{"section":"selinuxoptions-v1-core"},{"section":"runasuserstrategyoptions-v1beta1-extensions"},{"section":"rulewithoperations-v1alpha1-admissionregistration"},{"section":"rule-v1alpha1-admissionregistration"},{"section":"rollingupdatestatefulsetstrategy-v1beta1-apps"},{"section":"rollbackconfig-v1beta1-apps"},{"section":"roleref-v1-rbac"},{"section":"resourcerule-v1-authorization"},{"section":"resourcerequirements-v1-core"},{"section":"resourcemetricstatus-v2beta1-autoscaling"},{"section":"resourcemetricsource-v2beta1-autoscaling"},{"section":"resourcefieldselector-v1-core"},{"section":"resourceattributes-v1-authorization"},{"section":"replicationcontrollercondition-v1-core"},{"section":"replicasetcondition-v1beta1-extensions"},{"section":"rbdvolumesource-v1-core"},{"section":"quobytevolumesource-v1-core"},{"section":"quantity-resource-core"},{"section":"projectedvolumesource-v1-core"},{"section":"probe-v1-core"},{"section":"preferredschedulingterm-v1-core"},{"section":"preconditions-v1-meta"},{"section":"portworxvolumesource-v1-core"},{"section":"policyrule-v1-rbac"},{"section":"podsmetricstatus-v2beta1-autoscaling"},{"section":"podsmetricsource-v2beta1-autoscaling"},{"section":"podsecuritycontext-v1-core"},{"section":"podcondition-v1-core"},{"section":"podantiaffinity-v1-core"},{"section":"podaffinityterm-v1-core"},{"section":"podaffinity-v1-core"},{"section":"photonpersistentdiskvolumesource-v1-core"},{"section":"persistentvolumeclaimvolumesource-v1-core"},{"section":"persistentvolumeclaimcondition-v1-core"},{"section":"patch-v1-meta"},{"section":"ownerreference-v1-meta"},{"section":"objectreference-v1-core"},{"section":"objectmetricstatus-v2beta1-autoscaling"},{"section":"objectmetricsource-v2beta1-autoscaling"},{"section":"objectmeta-v1-meta"},{"section":"objectfieldselector-v1-core"},{"section":"nonresourcerule-v1-authorization"},{"section":"nonresourceattributes-v1-authorization"},{"section":"nodesysteminfo-v1-core"},{"section":"nodeselectorterm-v1-core"},{"section":"nodeselectorrequirement-v1-core"},{"section":"nodeselector-v1-core"},{"section":"nodedaemonendpoints-v1-core"},{"section":"nodeconfigsource-v1-core"},{"section":"nodecondition-v1-core"},{"section":"nodeaffinity-v1-core"},{"section":"nodeaddress-v1-core"},{"section":"networkpolicyport-v1-networking"},{"section":"networkpolicypeer-v1-networking"},{"section":"networkpolicyingressrule-v1-networking"},{"section":"networkpolicyegressrule-v1-networking"},{"section":"nfsvolumesource-v1-core"},{"section":"metricstatus-v2beta1-autoscaling"},{"section":"metricspec-v2beta1-autoscaling"},{"section":"localvolumesource-v1-core"},{"section":"localobjectreference-v1-core"},{"section":"loadbalancerstatus-v1-core"},{"section":"loadbalanceringress-v1-core"},{"section":"listmeta-v1-meta"},{"section":"limitrangeitem-v1-core"},{"section":"lifecycle-v1-core"},{"section":"labelselectorrequirement-v1-meta"},{"section":"labelselector-v1-meta"},{"section":"keytopath-v1-core"},{"section":"jobtemplatespec-v1beta1-batch"},{"section":"jobcondition-v1-batch"},{"section":"jsonschemapropsorbool-v1beta1-apiextensions"},{"section":"jsonschemapropsorarray-v1beta1-apiextensions"},{"section":"jsonschemaprops-v1beta1-apiextensions"},{"section":"json-v1beta1-apiextensions"},{"section":"initializers-v1-meta"},{"section":"initializer-v1-meta"},{"section":"ingresstls-v1beta1-extensions"},{"section":"ingressrule-v1beta1-extensions"},{"section":"ingressbackend-v1beta1-extensions"},{"section":"iscsivolumesource-v1-core"},{"section":"ipblock-v1-networking"},{"section":"idrange-v1beta1-extensions"},{"section":"hostportrange-v1beta1-extensions"},{"section":"hostpathvolumesource-v1-core"},{"section":"hostalias-v1-core"},{"section":"horizontalpodautoscalercondition-v2beta1-autoscaling"},{"section":"handler-v1-core"},{"section":"httpingressrulevalue-v1beta1-extensions"},{"section":"httpingresspath-v1beta1-extensions"},{"section":"httpheader-v1-core"},{"section":"httpgetaction-v1-core"},{"section":"groupversionfordiscovery-v1-meta"},{"section":"glusterfsvolumesource-v1-core"},{"section":"gitrepovolumesource-v1-core"},{"section":"gcepersistentdiskvolumesource-v1-core"},{"section":"flockervolumesource-v1-core"},{"section":"flexvolumesource-v1-core"},{"section":"fsgroupstrategyoptions-v1beta1-extensions"},{"section":"fcvolumesource-v1-core"},{"section":"externaldocumentation-v1beta1-apiextensions"},{"section":"externaladmissionhook-v1alpha1-admissionregistration"},{"section":"execaction-v1-core"},{"section":"eviction-v1beta1-policy"},{"section":"eventsource-v1-core"},{"section":"envvarsource-v1-core"},{"section":"envvar-v1-core"},{"section":"envfromsource-v1-core"},{"section":"endpointsubset-v1-core"},{"section":"endpointport-v1-core"},{"section":"endpointaddress-v1-core"},{"section":"emptydirvolumesource-v1-core"},{"section":"downwardapivolumesource-v1-core"},{"section":"downwardapivolumefile-v1-core"},{"section":"downwardapiprojection-v1-core"},{"section":"deploymentcondition-v1beta1-apps"},{"section":"deleteoptions-v1-meta"},{"section":"daemonsetupdatestrategy-v1beta1-extensions"},{"section":"daemonendpoint-v1-core"},{"section":"customresourcevalidation-v1beta1-apiextensions"},{"section":"customresourcedefinitionnames-v1beta1-apiextensions"},{"section":"customresourcedefinitioncondition-v1beta1-apiextensions"},{"section":"crossversionobjectreference-v1-autoscaling"},{"section":"containerstatewaiting-v1-core"},{"section":"containerstateterminated-v1-core"},{"section":"containerstaterunning-v1-core"},{"section":"containerstate-v1-core"},{"section":"containerport-v1-core"},{"section":"containerimage-v1-core"},{"section":"configmapvolumesource-v1-core"},{"section":"configmapprojection-v1-core"},{"section":"configmapkeyselector-v1-core"},{"section":"configmapenvsource-v1-core"},{"section":"componentcondition-v1-core"},{"section":"clientipconfig-v1-core"},{"section":"cindervolumesource-v1-core"},{"section":"certificatesigningrequestcondition-v1beta1-certificates"},{"section":"cephfsvolumesource-v1-core"},{"section":"cephfspersistentvolumesource-v1-core"},{"section":"capabilities-v1-core"},{"section":"azurefilevolumesource-v1-core"},{"section":"azurefilepersistentvolumesource-v1-core"},{"section":"azurediskvolumesource-v1-core"},{"section":"attachedvolume-v1-core"},{"section":"allowedhostpath-v1beta1-extensions"},{"section":"affinity-v1-core"},{"section":"admissionhookclientconfig-v1alpha1-admissionregistration"},{"section":"awselasticblockstorevolumesource-v1-core"},{"section":"apiversions-v1-meta"},{"section":"apiservicecondition-v1beta1-apiregistration"},{"section":"apiresource-v1-meta"},{"section":"apigroup-v1-meta"}]},{"section":"networkpolicy-v1-networking","subsections":[{"section":"-strong-read-operations-strong--585","subsections":[{"section":"watch-list-all-namespaces-591"},{"section":"watch-list-590"},{"section":"watch-589"},{"section":"list-all-namespaces-588"},{"section":"list-587"},{"section":"read-586"}]},{"section":"-strong-write-operations-strong--579","subsections":[{"section":"delete-collection-584"},{"section":"delete-583"},{"section":"replace-582"},{"section":"patch-581"},{"section":"create-580"}]}]},{"section":"tokenreview-v1-authentication","subsections":[{"section":"-strong-write-operations-strong--577","subsections":[{"section":"create-578"}]}]},{"section":"subjectaccessreview-v1-authorization","subsections":[{"section":"-strong-write-operations-strong--575","subsections":[{"section":"create-576"}]}]},{"section":"serviceaccount-v1-core","subsections":[{"section":"-strong-read-operations-strong--568","subsections":[{"section":"watch-list-all-namespaces-574"},{"section":"watch-list-573"},{"section":"watch-572"},{"section":"list-all-namespaces-571"},{"section":"list-570"},{"section":"read-569"}]},{"section":"-strong-write-operations-strong--562","subsections":[{"section":"delete-collection-567"},{"section":"delete-566"},{"section":"replace-565"},{"section":"patch-564"},{"section":"create-563"}]}]},{"section":"selfsubjectrulesreview-v1-authorization","subsections":[{"section":"-strong-write-operations-strong--560","subsections":[{"section":"create-561"}]}]},{"section":"selfsubjectaccessreview-v1-authorization","subsections":[{"section":"-strong-write-operations-strong--558","subsections":[{"section":"create-559"}]}]},{"section":"rolebinding-v1-rbac","subsections":[{"section":"-strong-read-operations-strong--551","subsections":[{"section":"watch-list-all-namespaces-557"},{"section":"watch-list-556"},{"section":"watch-555"},{"section":"list-all-namespaces-554"},{"section":"list-553"},{"section":"read-552"}]},{"section":"-strong-write-operations-strong--545","subsections":[{"section":"delete-collection-550"},{"section":"delete-549"},{"section":"replace-548"},{"section":"patch-547"},{"section":"create-546"}]}]},{"section":"role-v1-rbac","subsections":[{"section":"-strong-read-operations-strong--538","subsections":[{"section":"watch-list-all-namespaces-544"},{"section":"watch-list-543"},{"section":"watch-542"},{"section":"list-all-namespaces-541"},{"section":"list-540"},{"section":"read-539"}]},{"section":"-strong-write-operations-strong--532","subsections":[{"section":"delete-collection-537"},{"section":"delete-536"},{"section":"replace-535"},{"section":"patch-534"},{"section":"create-533"}]}]},{"section":"resourcequota-v1-core","subsections":[{"section":"-strong-status-operations-strong--528","subsections":[{"section":"replace-status-531"},{"section":"read-status-530"},{"section":"patch-status-529"}]},{"section":"-strong-read-operations-strong--521","subsections":[{"section":"watch-list-all-namespaces-527"},{"section":"watch-list-526"},{"section":"watch-525"},{"section":"list-all-namespaces-524"},{"section":"list-523"},{"section":"read-522"}]},{"section":"-strong-write-operations-strong--515","subsections":[{"section":"delete-collection-520"},{"section":"delete-519"},{"section":"replace-518"},{"section":"patch-517"},{"section":"create-516"}]}]},{"section":"persistentvolume-v1-core","subsections":[{"section":"-strong-status-operations-strong--511","subsections":[{"section":"replace-status-514"},{"section":"read-status-513"},{"section":"patch-status-512"}]},{"section":"-strong-read-operations-strong--506","subsections":[{"section":"watch-list-510"},{"section":"watch-509"},{"section":"list-508"},{"section":"read-507"}]},{"section":"-strong-write-operations-strong--500","subsections":[{"section":"delete-collection-505"},{"section":"delete-504"},{"section":"replace-503"},{"section":"patch-502"},{"section":"create-501"}]}]},{"section":"node-v1-core","subsections":[{"section":"-strong-proxy-operations-strong--481","subsections":[{"section":"replace-proxy-path-499"},{"section":"replace-proxy-498"},{"section":"replace-connect-proxy-path-497"},{"section":"replace-connect-proxy-496"},{"section":"head-connect-proxy-path-495"},{"section":"head-connect-proxy-494"},{"section":"get-proxy-path-493"},{"section":"get-proxy-492"},{"section":"get-connect-proxy-path-491"},{"section":"get-connect-proxy-490"},{"section":"delete-proxy-path-489"},{"section":"delete-proxy-488"},{"section":"delete-connect-proxy-path-487"},{"section":"delete-connect-proxy-486"},{"section":"create-proxy-path-485"},{"section":"create-proxy-484"},{"section":"create-connect-proxy-path-483"},{"section":"create-connect-proxy-482"}]},{"section":"-strong-status-operations-strong--477","subsections":[{"section":"replace-status-480"},{"section":"read-status-479"},{"section":"patch-status-478"}]},{"section":"-strong-read-operations-strong--472","subsections":[{"section":"watch-list-476"},{"section":"watch-475"},{"section":"list-474"},{"section":"read-473"}]},{"section":"-strong-write-operations-strong--466","subsections":[{"section":"delete-collection-471"},{"section":"delete-470"},{"section":"replace-469"},{"section":"patch-468"},{"section":"create-467"}]}]},{"section":"namespace-v1-core","subsections":[{"section":"-strong-status-operations-strong--462","subsections":[{"section":"replace-status-465"},{"section":"read-status-464"},{"section":"patch-status-463"}]},{"section":"-strong-read-operations-strong--457","subsections":[{"section":"watch-list-461"},{"section":"watch-460"},{"section":"list-459"},{"section":"read-458"}]},{"section":"-strong-write-operations-strong--452","subsections":[{"section":"delete-456"},{"section":"replace-455"},{"section":"patch-454"},{"section":"create-453"}]}]},{"section":"localsubjectaccessreview-v1-authorization","subsections":[{"section":"-strong-write-operations-strong--450","subsections":[{"section":"create-451"}]}]},{"section":"componentstatus-v1-core","subsections":[{"section":"-strong-read-operations-strong--447","subsections":[{"section":"list-449"},{"section":"read-448"}]}]},{"section":"clusterrolebinding-v1-rbac","subsections":[{"section":"-strong-read-operations-strong--442","subsections":[{"section":"watch-list-446"},{"section":"watch-445"},{"section":"list-444"},{"section":"read-443"}]},{"section":"-strong-write-operations-strong--436","subsections":[{"section":"delete-collection-441"},{"section":"delete-440"},{"section":"replace-439"},{"section":"patch-438"},{"section":"create-437"}]}]},{"section":"clusterrole-v1-rbac","subsections":[{"section":"-strong-read-operations-strong--431","subsections":[{"section":"watch-list-435"},{"section":"watch-434"},{"section":"list-433"},{"section":"read-432"}]},{"section":"-strong-write-operations-strong--425","subsections":[{"section":"delete-collection-430"},{"section":"delete-429"},{"section":"replace-428"},{"section":"patch-427"},{"section":"create-426"}]}]},{"section":"certificatesigningrequest-v1beta1-certificates","subsections":[{"section":"-strong-status-operations-strong--423","subsections":[{"section":"replace-status-424"}]},{"section":"-strong-read-operations-strong--418","subsections":[{"section":"watch-list-422"},{"section":"watch-421"},{"section":"list-420"},{"section":"read-419"}]},{"section":"-strong-write-operations-strong--412","subsections":[{"section":"delete-collection-417"},{"section":"delete-416"},{"section":"replace-415"},{"section":"patch-414"},{"section":"create-413"}]}]},{"section":"binding-v1-core","subsections":[{"section":"-strong-write-operations-strong--410","subsections":[{"section":"create-411"}]}]},{"section":"apiservice-v1beta1-apiregistration","subsections":[{"section":"-strong-status-operations-strong--408","subsections":[{"section":"replace-status-409"}]},{"section":"-strong-read-operations-strong--403","subsections":[{"section":"watch-list-407"},{"section":"watch-406"},{"section":"list-405"},{"section":"read-404"}]},{"section":"-strong-write-operations-strong--397","subsections":[{"section":"delete-collection-402"},{"section":"delete-401"},{"section":"replace-400"},{"section":"patch-399"},{"section":"create-398"}]}]},{"section":"-strong-cluster-strong-","subsections":[]},{"section":"podsecuritypolicy-v1beta1-extensions","subsections":[{"section":"-strong-read-operations-strong--392","subsections":[{"section":"watch-list-396"},{"section":"watch-395"},{"section":"list-394"},{"section":"read-393"}]},{"section":"-strong-write-operations-strong--386","subsections":[{"section":"delete-collection-391"},{"section":"delete-390"},{"section":"replace-389"},{"section":"patch-388"},{"section":"create-387"}]}]},{"section":"podpreset-v1alpha1-settings","subsections":[{"section":"-strong-read-operations-strong--379","subsections":[{"section":"watch-list-all-namespaces-385"},{"section":"watch-list-384"},{"section":"watch-383"},{"section":"list-all-namespaces-382"},{"section":"list-381"},{"section":"read-380"}]},{"section":"-strong-write-operations-strong--373","subsections":[{"section":"delete-collection-378"},{"section":"delete-377"},{"section":"replace-376"},{"section":"patch-375"},{"section":"create-374"}]}]},{"section":"priorityclass-v1alpha1-scheduling","subsections":[{"section":"-strong-read-operations-strong--368","subsections":[{"section":"watch-list-372"},{"section":"watch-371"},{"section":"list-370"},{"section":"read-369"}]},{"section":"-strong-write-operations-strong--362","subsections":[{"section":"delete-collection-367"},{"section":"delete-366"},{"section":"replace-365"},{"section":"patch-364"},{"section":"create-363"}]}]},{"section":"poddisruptionbudget-v1beta1-policy","subsections":[{"section":"-strong-status-operations-strong--358","subsections":[{"section":"replace-status-361"},{"section":"read-status-360"},{"section":"patch-status-359"}]},{"section":"-strong-read-operations-strong--351","subsections":[{"section":"watch-list-all-namespaces-357"},{"section":"watch-list-356"},{"section":"watch-355"},{"section":"list-all-namespaces-354"},{"section":"list-353"},{"section":"read-352"}]},{"section":"-strong-write-operations-strong--345","subsections":[{"section":"delete-collection-350"},{"section":"delete-349"},{"section":"replace-348"},{"section":"patch-347"},{"section":"create-346"}]}]},{"section":"podtemplate-v1-core","subsections":[{"section":"-strong-read-operations-strong--338","subsections":[{"section":"watch-list-all-namespaces-344"},{"section":"watch-list-343"},{"section":"watch-342"},{"section":"list-all-namespaces-341"},{"section":"list-340"},{"section":"read-339"}]},{"section":"-strong-write-operations-strong--332","subsections":[{"section":"delete-collection-337"},{"section":"delete-336"},{"section":"replace-335"},{"section":"patch-334"},{"section":"create-333"}]}]},{"section":"initializerconfiguration-v1alpha1-admissionregistration","subsections":[{"section":"-strong-read-operations-strong--327","subsections":[{"section":"watch-list-331"},{"section":"watch-330"},{"section":"list-329"},{"section":"read-328"}]},{"section":"-strong-write-operations-strong--321","subsections":[{"section":"delete-collection-326"},{"section":"delete-325"},{"section":"replace-324"},{"section":"patch-323"},{"section":"create-322"}]}]},{"section":"horizontalpodautoscaler-v1-autoscaling","subsections":[{"section":"-strong-status-operations-strong--317","subsections":[{"section":"replace-status-320"},{"section":"read-status-319"},{"section":"patch-status-318"}]},{"section":"-strong-read-operations-strong--310","subsections":[{"section":"watch-list-all-namespaces-316"},{"section":"watch-list-315"},{"section":"watch-314"},{"section":"list-all-namespaces-313"},{"section":"list-312"},{"section":"read-311"}]},{"section":"-strong-write-operations-strong--304","subsections":[{"section":"delete-collection-309"},{"section":"delete-308"},{"section":"replace-307"},{"section":"patch-306"},{"section":"create-305"}]}]},{"section":"externaladmissionhookconfiguration-v1alpha1-admissionregistration","subsections":[{"section":"-strong-read-operations-strong--299","subsections":[{"section":"watch-list-303"},{"section":"watch-302"},{"section":"list-301"},{"section":"read-300"}]},{"section":"-strong-write-operations-strong--293","subsections":[{"section":"delete-collection-298"},{"section":"delete-297"},{"section":"replace-296"},{"section":"patch-295"},{"section":"create-294"}]}]},{"section":"limitrange-v1-core","subsections":[{"section":"-strong-read-operations-strong--286","subsections":[{"section":"watch-list-all-namespaces-292"},{"section":"watch-list-291"},{"section":"watch-290"},{"section":"list-all-namespaces-289"},{"section":"list-288"},{"section":"read-287"}]},{"section":"-strong-write-operations-strong--280","subsections":[{"section":"delete-collection-285"},{"section":"delete-284"},{"section":"replace-283"},{"section":"patch-282"},{"section":"create-281"}]}]},{"section":"event-v1-core","subsections":[{"section":"-strong-read-operations-strong--273","subsections":[{"section":"watch-list-all-namespaces-279"},{"section":"watch-list-278"},{"section":"watch-277"},{"section":"list-all-namespaces-276"},{"section":"list-275"},{"section":"read-274"}]},{"section":"-strong-write-operations-strong--267","subsections":[{"section":"delete-collection-272"},{"section":"delete-271"},{"section":"replace-270"},{"section":"patch-269"},{"section":"create-268"}]}]},{"section":"customresourcedefinition-v1beta1-apiextensions","subsections":[{"section":"-strong-status-operations-strong--265","subsections":[{"section":"replace-status-266"}]},{"section":"-strong-read-operations-strong--260","subsections":[{"section":"watch-list-264"},{"section":"watch-263"},{"section":"list-262"},{"section":"read-261"}]},{"section":"-strong-write-operations-strong--254","subsections":[{"section":"delete-collection-259"},{"section":"delete-258"},{"section":"replace-257"},{"section":"patch-256"},{"section":"create-255"}]}]},{"section":"controllerrevision-v1beta1-apps","subsections":[{"section":"-strong-read-operations-strong--247","subsections":[{"section":"watch-list-all-namespaces-253"},{"section":"watch-list-252"},{"section":"watch-251"},{"section":"list-all-namespaces-250"},{"section":"list-249"},{"section":"read-248"}]},{"section":"-strong-write-operations-strong--241","subsections":[{"section":"delete-collection-246"},{"section":"delete-245"},{"section":"replace-244"},{"section":"patch-243"},{"section":"create-242"}]}]},{"section":"-strong-metadata-strong-","subsections":[]},{"section":"volume-v1-core","subsections":[]},{"section":"storageclass-v1-storage","subsections":[{"section":"-strong-read-operations-strong--236","subsections":[{"section":"watch-list-240"},{"section":"watch-239"},{"section":"list-238"},{"section":"read-237"}]},{"section":"-strong-write-operations-strong--230","subsections":[{"section":"delete-collection-235"},{"section":"delete-234"},{"section":"replace-233"},{"section":"patch-232"},{"section":"create-231"}]}]},{"section":"persistentvolumeclaim-v1-core","subsections":[{"section":"-strong-status-operations-strong--226","subsections":[{"section":"replace-status-229"},{"section":"read-status-228"},{"section":"patch-status-227"}]},{"section":"-strong-read-operations-strong--219","subsections":[{"section":"watch-list-all-namespaces-225"},{"section":"watch-list-224"},{"section":"watch-223"},{"section":"list-all-namespaces-222"},{"section":"list-221"},{"section":"read-220"}]},{"section":"-strong-write-operations-strong--213","subsections":[{"section":"delete-collection-218"},{"section":"delete-217"},{"section":"replace-216"},{"section":"patch-215"},{"section":"create-214"}]}]},{"section":"secret-v1-core","subsections":[{"section":"-strong-read-operations-strong--206","subsections":[{"section":"watch-list-all-namespaces-212"},{"section":"watch-list-211"},{"section":"watch-210"},{"section":"list-all-namespaces-209"},{"section":"list-208"},{"section":"read-207"}]},{"section":"-strong-write-operations-strong--200","subsections":[{"section":"delete-collection-205"},{"section":"delete-204"},{"section":"replace-203"},{"section":"patch-202"},{"section":"create-201"}]}]},{"section":"configmap-v1-core","subsections":[{"section":"-strong-read-operations-strong--193","subsections":[{"section":"watch-list-all-namespaces-199"},{"section":"watch-list-198"},{"section":"watch-197"},{"section":"list-all-namespaces-196"},{"section":"list-195"},{"section":"read-194"}]},{"section":"-strong-write-operations-strong--187","subsections":[{"section":"delete-collection-192"},{"section":"delete-191"},{"section":"replace-190"},{"section":"patch-189"},{"section":"create-188"}]}]},{"section":"-strong-config-storage-strong-","subsections":[]},{"section":"service-v1-core","subsections":[{"section":"-strong-proxy-operations-strong--168","subsections":[{"section":"replace-proxy-path-186"},{"section":"replace-proxy-185"},{"section":"replace-connect-proxy-path-184"},{"section":"replace-connect-proxy-183"},{"section":"head-connect-proxy-path-182"},{"section":"head-connect-proxy-181"},{"section":"get-proxy-path-180"},{"section":"get-proxy-179"},{"section":"get-connect-proxy-path-178"},{"section":"get-connect-proxy-177"},{"section":"delete-proxy-path-176"},{"section":"delete-proxy-175"},{"section":"delete-connect-proxy-path-174"},{"section":"delete-connect-proxy-173"},{"section":"create-proxy-path-172"},{"section":"create-proxy-171"},{"section":"create-connect-proxy-path-170"},{"section":"create-connect-proxy-169"}]},{"section":"-strong-status-operations-strong--164","subsections":[{"section":"replace-status-167"},{"section":"read-status-166"},{"section":"patch-status-165"}]},{"section":"-strong-read-operations-strong--157","subsections":[{"section":"watch-list-all-namespaces-163"},{"section":"watch-list-162"},{"section":"watch-161"},{"section":"list-all-namespaces-160"},{"section":"list-159"},{"section":"read-158"}]},{"section":"-strong-write-operations-strong--152","subsections":[{"section":"delete-156"},{"section":"replace-155"},{"section":"patch-154"},{"section":"create-153"}]}]},{"section":"ingress-v1beta1-extensions","subsections":[{"section":"-strong-status-operations-strong--148","subsections":[{"section":"replace-status-151"},{"section":"read-status-150"},{"section":"patch-status-149"}]},{"section":"-strong-read-operations-strong--141","subsections":[{"section":"watch-list-all-namespaces-147"},{"section":"watch-list-146"},{"section":"watch-145"},{"section":"list-all-namespaces-144"},{"section":"list-143"},{"section":"read-142"}]},{"section":"-strong-write-operations-strong--135","subsections":[{"section":"delete-collection-140"},{"section":"delete-139"},{"section":"replace-138"},{"section":"patch-137"},{"section":"create-136"}]}]},{"section":"endpoints-v1-core","subsections":[{"section":"-strong-read-operations-strong--128","subsections":[{"section":"watch-list-all-namespaces-134"},{"section":"watch-list-133"},{"section":"watch-132"},{"section":"list-all-namespaces-131"},{"section":"list-130"},{"section":"read-129"}]},{"section":"-strong-write-operations-strong--122","subsections":[{"section":"delete-collection-127"},{"section":"delete-126"},{"section":"replace-125"},{"section":"patch-124"},{"section":"create-123"}]}]},{"section":"-strong-discovery-load-balancing-strong-","subsections":[]},{"section":"statefulset-v1beta1-apps","subsections":[{"section":"-strong-status-operations-strong--118","subsections":[{"section":"replace-status-121"},{"section":"read-status-120"},{"section":"patch-status-119"}]},{"section":"-strong-read-operations-strong--111","subsections":[{"section":"watch-list-all-namespaces-117"},{"section":"watch-list-116"},{"section":"watch-115"},{"section":"list-all-namespaces-114"},{"section":"list-113"},{"section":"read-112"}]},{"section":"-strong-write-operations-strong--105","subsections":[{"section":"delete-collection-110"},{"section":"delete-109"},{"section":"replace-108"},{"section":"patch-107"},{"section":"create-106"}]}]},{"section":"replicationcontroller-v1-core","subsections":[{"section":"-strong-status-operations-strong--101","subsections":[{"section":"replace-status-104"},{"section":"read-status-103"},{"section":"patch-status-102"}]},{"section":"-strong-read-operations-strong--94","subsections":[{"section":"watch-list-all-namespaces-100"},{"section":"watch-list-99"},{"section":"watch-98"},{"section":"list-all-namespaces-97"},{"section":"list-96"},{"section":"read-95"}]},{"section":"-strong-write-operations-strong--88","subsections":[{"section":"delete-collection-93"},{"section":"delete-92"},{"section":"replace-91"},{"section":"patch-90"},{"section":"create-89"}]}]},{"section":"replicaset-v1beta1-extensions","subsections":[{"section":"-strong-status-operations-strong--84","subsections":[{"section":"replace-status-87"},{"section":"read-status-86"},{"section":"patch-status-85"}]},{"section":"-strong-read-operations-strong--77","subsections":[{"section":"watch-list-all-namespaces-83"},{"section":"watch-list-82"},{"section":"watch-81"},{"section":"list-all-namespaces-80"},{"section":"list-79"},{"section":"read-78"}]},{"section":"-strong-write-operations-strong--71","subsections":[{"section":"delete-collection-76"},{"section":"delete-75"},{"section":"replace-74"},{"section":"patch-73"},{"section":"create-72"}]}]},{"section":"pod-v1-core","subsections":[{"section":"-strong-misc-operations-strong-","subsections":[{"section":"read-log"}]},{"section":"-strong-proxy-operations-strong-","subsections":[{"section":"replace-proxy-path"},{"section":"replace-proxy"},{"section":"replace-connect-proxy-path"},{"section":"replace-connect-proxy"},{"section":"head-connect-proxy-path"},{"section":"head-connect-proxy"},{"section":"get-proxy-path"},{"section":"get-proxy"},{"section":"get-connect-proxy-path"},{"section":"get-connect-proxy"},{"section":"get-connect-portforward"},{"section":"delete-proxy-path"},{"section":"delete-proxy"},{"section":"delete-connect-proxy-path"},{"section":"delete-connect-proxy"},{"section":"create-proxy-path"},{"section":"create-proxy"},{"section":"create-connect-proxy-path"},{"section":"create-connect-proxy"},{"section":"create-connect-portforward"}]},{"section":"-strong-status-operations-strong--67","subsections":[{"section":"replace-status-70"},{"section":"read-status-69"},{"section":"patch-status-68"}]},{"section":"-strong-read-operations-strong--60","subsections":[{"section":"watch-list-all-namespaces-66"},{"section":"watch-list-65"},{"section":"watch-64"},{"section":"list-all-namespaces-63"},{"section":"list-62"},{"section":"read-61"}]},{"section":"-strong-write-operations-strong--54","subsections":[{"section":"delete-collection-59"},{"section":"delete-58"},{"section":"replace-57"},{"section":"patch-56"},{"section":"create-55"}]}]},{"section":"job-v1-batch","subsections":[{"section":"-strong-status-operations-strong--50","subsections":[{"section":"replace-status-53"},{"section":"read-status-52"},{"section":"patch-status-51"}]},{"section":"-strong-read-operations-strong--43","subsections":[{"section":"watch-list-all-namespaces-49"},{"section":"watch-list-48"},{"section":"watch-47"},{"section":"list-all-namespaces-46"},{"section":"list-45"},{"section":"read-44"}]},{"section":"-strong-write-operations-strong--37","subsections":[{"section":"delete-collection-42"},{"section":"delete-41"},{"section":"replace-40"},{"section":"patch-39"},{"section":"create-38"}]}]},{"section":"deployment-v1beta1-apps","subsections":[{"section":"-strong-status-operations-strong--33","subsections":[{"section":"replace-status-36"},{"section":"read-status-35"},{"section":"patch-status-34"}]},{"section":"-strong-read-operations-strong--26","subsections":[{"section":"watch-list-all-namespaces-32"},{"section":"watch-list-31"},{"section":"watch-30"},{"section":"list-all-namespaces-29"},{"section":"list-28"},{"section":"read-27"}]},{"section":"-strong-write-operations-strong--20","subsections":[{"section":"delete-collection-25"},{"section":"delete-24"},{"section":"replace-23"},{"section":"patch-22"},{"section":"create-21"}]}]},{"section":"daemonset-v1beta1-extensions","subsections":[{"section":"-strong-status-operations-strong--16","subsections":[{"section":"replace-status-19"},{"section":"read-status-18"},{"section":"patch-status-17"}]},{"section":"-strong-read-operations-strong--9","subsections":[{"section":"watch-list-all-namespaces-15"},{"section":"watch-list-14"},{"section":"watch-13"},{"section":"list-all-namespaces-12"},{"section":"list-11"},{"section":"read-10"}]},{"section":"-strong-write-operations-strong--3","subsections":[{"section":"delete-collection-8"},{"section":"delete-7"},{"section":"replace-6"},{"section":"patch-5"},{"section":"create-4"}]}]},{"section":"cronjob-v1beta1-batch","subsections":[{"section":"-strong-status-operations-strong-","subsections":[{"section":"replace-status"},{"section":"read-status"},{"section":"patch-status"}]},{"section":"-strong-read-operations-strong-","subsections":[{"section":"watch-list-all-namespaces"},{"section":"watch-list"},{"section":"watch"},{"section":"list-all-namespaces"},{"section":"list"},{"section":"read-2"}]},{"section":"-strong-write-operations-strong-","subsections":[{"section":"delete-collection"},{"section":"delete-1"},{"section":"replace"},{"section":"patch"},{"section":"create"}]}]},{"section":"container-v1-core","subsections":[]},{"section":"-strong-workloads-strong-","subsections":[]},{"section":"-strong-api-overview-strong-","subsections":[{"section":"resource-operations"},{"section":"resource-objects"},{"section":"resource-categories"}]}],"flatToc":["userinfo-v1beta1-authentication","create-853","-strong-write-operations-strong--852","tokenreview-v1beta1-authentication","subjectrulesreviewstatus-v1beta1-authorization","create-851","-strong-write-operations-strong--850","subjectaccessreview-v1beta1-authorization","subject-v1alpha1-rbac","subject-v1beta1-rbac","watch-list-849","watch-848","list-847","read-846","-strong-read-operations-strong--845","delete-collection-844","delete-843","replace-842","patch-841","create-840","-strong-write-operations-strong--839","storageclass-v1beta1-storage","statefulsetupdatestrategy-v1beta2-apps","replace-status-838","read-status-837","patch-status-836","-strong-status-operations-strong--835","watch-list-all-namespaces-834","watch-list-833","watch-832","list-all-namespaces-831","list-830","read-829","-strong-read-operations-strong--828","delete-collection-827","delete-826","replace-825","patch-824","create-823","-strong-write-operations-strong--822","statefulset-v1beta2-apps","servicereference-v1alpha1-admissionregistration","create-821","-strong-write-operations-strong--820","selfsubjectrulesreview-v1beta1-authorization","create-819","-strong-write-operations-strong--818","selfsubjectaccessreview-v1beta1-authorization","scale-v1beta2-apps","scale-v1beta1-extensions","scale-v1beta1-apps","rollingupdatestatefulsetstrategy-v1beta2-apps","rollbackconfig-v1beta1-extensions","roleref-v1alpha1-rbac","roleref-v1beta1-rbac","watch-list-all-namespaces-817","watch-list-816","watch-815","list-all-namespaces-814","list-813","read-812","-strong-read-operations-strong--811","delete-collection-810","delete-809","replace-808","patch-807","create-806","-strong-write-operations-strong--805","rolebinding-v1alpha1-rbac","watch-list-all-namespaces-804","watch-list-803","watch-802","list-all-namespaces-801","list-800","read-799","-strong-read-operations-strong--798","delete-collection-797","delete-796","replace-795","patch-794","create-793","-strong-write-operations-strong--792","rolebinding-v1beta1-rbac","watch-list-all-namespaces-791","watch-list-790","watch-789","list-all-namespaces-788","list-787","read-786","-strong-read-operations-strong--785","delete-collection-784","delete-783","replace-782","patch-781","create-780","-strong-write-operations-strong--779","role-v1alpha1-rbac","watch-list-all-namespaces-778","watch-list-777","watch-776","list-all-namespaces-775","list-774","read-773","-strong-read-operations-strong--772","delete-collection-771","delete-770","replace-769","patch-768","create-767","-strong-write-operations-strong--766","role-v1beta1-rbac","resourcerule-v1beta1-authorization","resourceattributes-v1beta1-authorization","replicasetcondition-v1beta2-apps","replace-status-765","read-status-764","patch-status-763","-strong-status-operations-strong--762","watch-list-all-namespaces-761","watch-list-760","watch-759","list-all-namespaces-758","list-757","read-756","-strong-read-operations-strong--755","delete-collection-754","delete-753","replace-752","patch-751","create-750","-strong-write-operations-strong--749","replicaset-v1beta2-apps","policyrule-v1alpha1-rbac","policyrule-v1beta1-rbac","nonresourcerule-v1beta1-authorization","nonresourceattributes-v1beta1-authorization","networkpolicyport-v1beta1-extensions","networkpolicypeer-v1beta1-extensions","networkpolicyingressrule-v1beta1-extensions","networkpolicyegressrule-v1beta1-extensions","watch-list-all-namespaces-748","watch-list-747","watch-746","list-all-namespaces-745","list-744","read-743","-strong-read-operations-strong--742","delete-collection-741","delete-740","replace-739","patch-738","create-737","-strong-write-operations-strong--736","networkpolicy-v1beta1-extensions","create-735","-strong-write-operations-strong--734","localsubjectaccessreview-v1beta1-authorization","jobtemplatespec-v2alpha1-batch","initializer-v1alpha1-admissionregistration","ipblock-v1beta1-extensions","replace-status-733","read-status-732","patch-status-731","-strong-status-operations-strong--730","watch-list-all-namespaces-729","watch-list-728","watch-727","list-all-namespaces-726","list-725","read-724","-strong-read-operations-strong--723","delete-collection-722","delete-721","replace-720","patch-719","create-718","-strong-write-operations-strong--717","horizontalpodautoscaler-v2beta1-autoscaling","deploymentcondition-v1beta2-apps","deploymentcondition-v1beta1-extensions","replace-status-716","read-status-715","patch-status-714","-strong-status-operations-strong--713","watch-list-all-namespaces-712","watch-list-711","watch-710","list-all-namespaces-709","list-708","read-707","-strong-read-operations-strong--706","delete-collection-705","delete-704","replace-703","patch-702","create-701","-strong-write-operations-strong--700","deployment-v1beta2-apps","replace-status-699","read-status-698","patch-status-697","-strong-status-operations-strong--696","watch-list-all-namespaces-695","watch-list-694","watch-693","list-all-namespaces-692","list-691","read-690","-strong-read-operations-strong--689","delete-collection-688","delete-687","replace-686","patch-685","create-684","-strong-write-operations-strong--683","deployment-v1beta1-extensions","daemonsetupdatestrategy-v1beta2-apps","replace-status-682","read-status-681","patch-status-680","-strong-status-operations-strong--679","watch-list-all-namespaces-678","watch-list-677","watch-676","list-all-namespaces-675","list-674","read-673","-strong-read-operations-strong--672","delete-collection-671","delete-670","replace-669","patch-668","create-667","-strong-write-operations-strong--666","daemonset-v1beta2-apps","crossversionobjectreference-v2beta1-autoscaling","replace-status-665","read-status-664","patch-status-663","-strong-status-operations-strong--662","watch-list-all-namespaces-661","watch-list-660","watch-659","list-all-namespaces-658","list-657","read-656","-strong-read-operations-strong--655","delete-collection-654","delete-653","replace-652","patch-651","create-650","-strong-write-operations-strong--649","cronjob-v2alpha1-batch","watch-list-all-namespaces-648","watch-list-647","watch-646","list-all-namespaces-645","list-644","read-643","-strong-read-operations-strong--642","delete-collection-641","delete-640","replace-639","patch-638","create-637","-strong-write-operations-strong--636","controllerrevision-v1beta2-apps","watch-list-635","watch-634","list-633","read-632","-strong-read-operations-strong--631","delete-collection-630","delete-629","replace-628","patch-627","create-626","-strong-write-operations-strong--625","clusterrolebinding-v1alpha1-rbac","watch-list-624","watch-623","list-622","read-621","-strong-read-operations-strong--620","delete-collection-619","delete-618","replace-617","patch-616","create-615","-strong-write-operations-strong--614","clusterrolebinding-v1beta1-rbac","watch-list-613","watch-612","list-611","read-610","-strong-read-operations-strong--609","delete-collection-608","delete-607","replace-606","patch-605","create-604","-strong-write-operations-strong--603","clusterrole-v1alpha1-rbac","watch-list-602","watch-601","list-600","read-599","-strong-read-operations-strong--598","delete-collection-597","delete-596","replace-595","patch-594","create-593","-strong-write-operations-strong--592","clusterrole-v1beta1-rbac","-strong-old-api-versions-strong-","weightedpodaffinityterm-v1-core","watchevent-v1-meta","vspherevirtualdiskvolumesource-v1-core","volumeprojection-v1-core","volumemount-v1-core","userinfo-v1-authentication","toleration-v1-core","time-v1-meta","taint-v1-core","tcpsocketaction-v1-core","supplementalgroupsstrategyoptions-v1beta1-extensions","subjectrulesreviewstatus-v1-authorization","subject-v1-rbac","storageosvolumesource-v1-core","storageospersistentvolumesource-v1-core","statusdetails-v1-meta","statuscause-v1-meta","status-v1-meta","statefulsetupdatestrategy-v1beta1-apps","sessionaffinityconfig-v1-core","servicereference-v1beta1-apiregistration","serviceport-v1-core","serveraddressbyclientcidr-v1-meta","securitycontext-v1-core","secretvolumesource-v1-core","secretreference-v1-core","secretprojection-v1-core","secretkeyselector-v1-core","secretenvsource-v1-core","scaleiovolumesource-v1-core","scale-v1-autoscaling","selinuxstrategyoptions-v1beta1-extensions","selinuxoptions-v1-core","runasuserstrategyoptions-v1beta1-extensions","rulewithoperations-v1alpha1-admissionregistration","rule-v1alpha1-admissionregistration","rollingupdatestatefulsetstrategy-v1beta1-apps","rollbackconfig-v1beta1-apps","roleref-v1-rbac","resourcerule-v1-authorization","resourcerequirements-v1-core","resourcemetricstatus-v2beta1-autoscaling","resourcemetricsource-v2beta1-autoscaling","resourcefieldselector-v1-core","resourceattributes-v1-authorization","replicationcontrollercondition-v1-core","replicasetcondition-v1beta1-extensions","rbdvolumesource-v1-core","quobytevolumesource-v1-core","quantity-resource-core","projectedvolumesource-v1-core","probe-v1-core","preferredschedulingterm-v1-core","preconditions-v1-meta","portworxvolumesource-v1-core","policyrule-v1-rbac","podsmetricstatus-v2beta1-autoscaling","podsmetricsource-v2beta1-autoscaling","podsecuritycontext-v1-core","podcondition-v1-core","podantiaffinity-v1-core","podaffinityterm-v1-core","podaffinity-v1-core","photonpersistentdiskvolumesource-v1-core","persistentvolumeclaimvolumesource-v1-core","persistentvolumeclaimcondition-v1-core","patch-v1-meta","ownerreference-v1-meta","objectreference-v1-core","objectmetricstatus-v2beta1-autoscaling","objectmetricsource-v2beta1-autoscaling","objectmeta-v1-meta","objectfieldselector-v1-core","nonresourcerule-v1-authorization","nonresourceattributes-v1-authorization","nodesysteminfo-v1-core","nodeselectorterm-v1-core","nodeselectorrequirement-v1-core","nodeselector-v1-core","nodedaemonendpoints-v1-core","nodeconfigsource-v1-core","nodecondition-v1-core","nodeaffinity-v1-core","nodeaddress-v1-core","networkpolicyport-v1-networking","networkpolicypeer-v1-networking","networkpolicyingressrule-v1-networking","networkpolicyegressrule-v1-networking","nfsvolumesource-v1-core","metricstatus-v2beta1-autoscaling","metricspec-v2beta1-autoscaling","localvolumesource-v1-core","localobjectreference-v1-core","loadbalancerstatus-v1-core","loadbalanceringress-v1-core","listmeta-v1-meta","limitrangeitem-v1-core","lifecycle-v1-core","labelselectorrequirement-v1-meta","labelselector-v1-meta","keytopath-v1-core","jobtemplatespec-v1beta1-batch","jobcondition-v1-batch","jsonschemapropsorbool-v1beta1-apiextensions","jsonschemapropsorarray-v1beta1-apiextensions","jsonschemaprops-v1beta1-apiextensions","json-v1beta1-apiextensions","initializers-v1-meta","initializer-v1-meta","ingresstls-v1beta1-extensions","ingressrule-v1beta1-extensions","ingressbackend-v1beta1-extensions","iscsivolumesource-v1-core","ipblock-v1-networking","idrange-v1beta1-extensions","hostportrange-v1beta1-extensions","hostpathvolumesource-v1-core","hostalias-v1-core","horizontalpodautoscalercondition-v2beta1-autoscaling","handler-v1-core","httpingressrulevalue-v1beta1-extensions","httpingresspath-v1beta1-extensions","httpheader-v1-core","httpgetaction-v1-core","groupversionfordiscovery-v1-meta","glusterfsvolumesource-v1-core","gitrepovolumesource-v1-core","gcepersistentdiskvolumesource-v1-core","flockervolumesource-v1-core","flexvolumesource-v1-core","fsgroupstrategyoptions-v1beta1-extensions","fcvolumesource-v1-core","externaldocumentation-v1beta1-apiextensions","externaladmissionhook-v1alpha1-admissionregistration","execaction-v1-core","eviction-v1beta1-policy","eventsource-v1-core","envvarsource-v1-core","envvar-v1-core","envfromsource-v1-core","endpointsubset-v1-core","endpointport-v1-core","endpointaddress-v1-core","emptydirvolumesource-v1-core","downwardapivolumesource-v1-core","downwardapivolumefile-v1-core","downwardapiprojection-v1-core","deploymentcondition-v1beta1-apps","deleteoptions-v1-meta","daemonsetupdatestrategy-v1beta1-extensions","daemonendpoint-v1-core","customresourcevalidation-v1beta1-apiextensions","customresourcedefinitionnames-v1beta1-apiextensions","customresourcedefinitioncondition-v1beta1-apiextensions","crossversionobjectreference-v1-autoscaling","containerstatewaiting-v1-core","containerstateterminated-v1-core","containerstaterunning-v1-core","containerstate-v1-core","containerport-v1-core","containerimage-v1-core","configmapvolumesource-v1-core","configmapprojection-v1-core","configmapkeyselector-v1-core","configmapenvsource-v1-core","componentcondition-v1-core","clientipconfig-v1-core","cindervolumesource-v1-core","certificatesigningrequestcondition-v1beta1-certificates","cephfsvolumesource-v1-core","cephfspersistentvolumesource-v1-core","capabilities-v1-core","azurefilevolumesource-v1-core","azurefilepersistentvolumesource-v1-core","azurediskvolumesource-v1-core","attachedvolume-v1-core","allowedhostpath-v1beta1-extensions","affinity-v1-core","admissionhookclientconfig-v1alpha1-admissionregistration","awselasticblockstorevolumesource-v1-core","apiversions-v1-meta","apiservicecondition-v1beta1-apiregistration","apiresource-v1-meta","apigroup-v1-meta","-strong-definitions-strong-","watch-list-all-namespaces-591","watch-list-590","watch-589","list-all-namespaces-588","list-587","read-586","-strong-read-operations-strong--585","delete-collection-584","delete-583","replace-582","patch-581","create-580","-strong-write-operations-strong--579","networkpolicy-v1-networking","create-578","-strong-write-operations-strong--577","tokenreview-v1-authentication","create-576","-strong-write-operations-strong--575","subjectaccessreview-v1-authorization","watch-list-all-namespaces-574","watch-list-573","watch-572","list-all-namespaces-571","list-570","read-569","-strong-read-operations-strong--568","delete-collection-567","delete-566","replace-565","patch-564","create-563","-strong-write-operations-strong--562","serviceaccount-v1-core","create-561","-strong-write-operations-strong--560","selfsubjectrulesreview-v1-authorization","create-559","-strong-write-operations-strong--558","selfsubjectaccessreview-v1-authorization","watch-list-all-namespaces-557","watch-list-556","watch-555","list-all-namespaces-554","list-553","read-552","-strong-read-operations-strong--551","delete-collection-550","delete-549","replace-548","patch-547","create-546","-strong-write-operations-strong--545","rolebinding-v1-rbac","watch-list-all-namespaces-544","watch-list-543","watch-542","list-all-namespaces-541","list-540","read-539","-strong-read-operations-strong--538","delete-collection-537","delete-536","replace-535","patch-534","create-533","-strong-write-operations-strong--532","role-v1-rbac","replace-status-531","read-status-530","patch-status-529","-strong-status-operations-strong--528","watch-list-all-namespaces-527","watch-list-526","watch-525","list-all-namespaces-524","list-523","read-522","-strong-read-operations-strong--521","delete-collection-520","delete-519","replace-518","patch-517","create-516","-strong-write-operations-strong--515","resourcequota-v1-core","replace-status-514","read-status-513","patch-status-512","-strong-status-operations-strong--511","watch-list-510","watch-509","list-508","read-507","-strong-read-operations-strong--506","delete-collection-505","delete-504","replace-503","patch-502","create-501","-strong-write-operations-strong--500","persistentvolume-v1-core","replace-proxy-path-499","replace-proxy-498","replace-connect-proxy-path-497","replace-connect-proxy-496","head-connect-proxy-path-495","head-connect-proxy-494","get-proxy-path-493","get-proxy-492","get-connect-proxy-path-491","get-connect-proxy-490","delete-proxy-path-489","delete-proxy-488","delete-connect-proxy-path-487","delete-connect-proxy-486","create-proxy-path-485","create-proxy-484","create-connect-proxy-path-483","create-connect-proxy-482","-strong-proxy-operations-strong--481","replace-status-480","read-status-479","patch-status-478","-strong-status-operations-strong--477","watch-list-476","watch-475","list-474","read-473","-strong-read-operations-strong--472","delete-collection-471","delete-470","replace-469","patch-468","create-467","-strong-write-operations-strong--466","node-v1-core","replace-status-465","read-status-464","patch-status-463","-strong-status-operations-strong--462","watch-list-461","watch-460","list-459","read-458","-strong-read-operations-strong--457","delete-456","replace-455","patch-454","create-453","-strong-write-operations-strong--452","namespace-v1-core","create-451","-strong-write-operations-strong--450","localsubjectaccessreview-v1-authorization","list-449","read-448","-strong-read-operations-strong--447","componentstatus-v1-core","watch-list-446","watch-445","list-444","read-443","-strong-read-operations-strong--442","delete-collection-441","delete-440","replace-439","patch-438","create-437","-strong-write-operations-strong--436","clusterrolebinding-v1-rbac","watch-list-435","watch-434","list-433","read-432","-strong-read-operations-strong--431","delete-collection-430","delete-429","replace-428","patch-427","create-426","-strong-write-operations-strong--425","clusterrole-v1-rbac","replace-status-424","-strong-status-operations-strong--423","watch-list-422","watch-421","list-420","read-419","-strong-read-operations-strong--418","delete-collection-417","delete-416","replace-415","patch-414","create-413","-strong-write-operations-strong--412","certificatesigningrequest-v1beta1-certificates","create-411","-strong-write-operations-strong--410","binding-v1-core","replace-status-409","-strong-status-operations-strong--408","watch-list-407","watch-406","list-405","read-404","-strong-read-operations-strong--403","delete-collection-402","delete-401","replace-400","patch-399","create-398","-strong-write-operations-strong--397","apiservice-v1beta1-apiregistration","-strong-cluster-strong-","watch-list-396","watch-395","list-394","read-393","-strong-read-operations-strong--392","delete-collection-391","delete-390","replace-389","patch-388","create-387","-strong-write-operations-strong--386","podsecuritypolicy-v1beta1-extensions","watch-list-all-namespaces-385","watch-list-384","watch-383","list-all-namespaces-382","list-381","read-380","-strong-read-operations-strong--379","delete-collection-378","delete-377","replace-376","patch-375","create-374","-strong-write-operations-strong--373","podpreset-v1alpha1-settings","watch-list-372","watch-371","list-370","read-369","-strong-read-operations-strong--368","delete-collection-367","delete-366","replace-365","patch-364","create-363","-strong-write-operations-strong--362","priorityclass-v1alpha1-scheduling","replace-status-361","read-status-360","patch-status-359","-strong-status-operations-strong--358","watch-list-all-namespaces-357","watch-list-356","watch-355","list-all-namespaces-354","list-353","read-352","-strong-read-operations-strong--351","delete-collection-350","delete-349","replace-348","patch-347","create-346","-strong-write-operations-strong--345","poddisruptionbudget-v1beta1-policy","watch-list-all-namespaces-344","watch-list-343","watch-342","list-all-namespaces-341","list-340","read-339","-strong-read-operations-strong--338","delete-collection-337","delete-336","replace-335","patch-334","create-333","-strong-write-operations-strong--332","podtemplate-v1-core","watch-list-331","watch-330","list-329","read-328","-strong-read-operations-strong--327","delete-collection-326","delete-325","replace-324","patch-323","create-322","-strong-write-operations-strong--321","initializerconfiguration-v1alpha1-admissionregistration","replace-status-320","read-status-319","patch-status-318","-strong-status-operations-strong--317","watch-list-all-namespaces-316","watch-list-315","watch-314","list-all-namespaces-313","list-312","read-311","-strong-read-operations-strong--310","delete-collection-309","delete-308","replace-307","patch-306","create-305","-strong-write-operations-strong--304","horizontalpodautoscaler-v1-autoscaling","watch-list-303","watch-302","list-301","read-300","-strong-read-operations-strong--299","delete-collection-298","delete-297","replace-296","patch-295","create-294","-strong-write-operations-strong--293","externaladmissionhookconfiguration-v1alpha1-admissionregistration","watch-list-all-namespaces-292","watch-list-291","watch-290","list-all-namespaces-289","list-288","read-287","-strong-read-operations-strong--286","delete-collection-285","delete-284","replace-283","patch-282","create-281","-strong-write-operations-strong--280","limitrange-v1-core","watch-list-all-namespaces-279","watch-list-278","watch-277","list-all-namespaces-276","list-275","read-274","-strong-read-operations-strong--273","delete-collection-272","delete-271","replace-270","patch-269","create-268","-strong-write-operations-strong--267","event-v1-core","replace-status-266","-strong-status-operations-strong--265","watch-list-264","watch-263","list-262","read-261","-strong-read-operations-strong--260","delete-collection-259","delete-258","replace-257","patch-256","create-255","-strong-write-operations-strong--254","customresourcedefinition-v1beta1-apiextensions","watch-list-all-namespaces-253","watch-list-252","watch-251","list-all-namespaces-250","list-249","read-248","-strong-read-operations-strong--247","delete-collection-246","delete-245","replace-244","patch-243","create-242","-strong-write-operations-strong--241","controllerrevision-v1beta1-apps","-strong-metadata-strong-","volume-v1-core","watch-list-240","watch-239","list-238","read-237","-strong-read-operations-strong--236","delete-collection-235","delete-234","replace-233","patch-232","create-231","-strong-write-operations-strong--230","storageclass-v1-storage","replace-status-229","read-status-228","patch-status-227","-strong-status-operations-strong--226","watch-list-all-namespaces-225","watch-list-224","watch-223","list-all-namespaces-222","list-221","read-220","-strong-read-operations-strong--219","delete-collection-218","delete-217","replace-216","patch-215","create-214","-strong-write-operations-strong--213","persistentvolumeclaim-v1-core","watch-list-all-namespaces-212","watch-list-211","watch-210","list-all-namespaces-209","list-208","read-207","-strong-read-operations-strong--206","delete-collection-205","delete-204","replace-203","patch-202","create-201","-strong-write-operations-strong--200","secret-v1-core","watch-list-all-namespaces-199","watch-list-198","watch-197","list-all-namespaces-196","list-195","read-194","-strong-read-operations-strong--193","delete-collection-192","delete-191","replace-190","patch-189","create-188","-strong-write-operations-strong--187","configmap-v1-core","-strong-config-storage-strong-","replace-proxy-path-186","replace-proxy-185","replace-connect-proxy-path-184","replace-connect-proxy-183","head-connect-proxy-path-182","head-connect-proxy-181","get-proxy-path-180","get-proxy-179","get-connect-proxy-path-178","get-connect-proxy-177","delete-proxy-path-176","delete-proxy-175","delete-connect-proxy-path-174","delete-connect-proxy-173","create-proxy-path-172","create-proxy-171","create-connect-proxy-path-170","create-connect-proxy-169","-strong-proxy-operations-strong--168","replace-status-167","read-status-166","patch-status-165","-strong-status-operations-strong--164","watch-list-all-namespaces-163","watch-list-162","watch-161","list-all-namespaces-160","list-159","read-158","-strong-read-operations-strong--157","delete-156","replace-155","patch-154","create-153","-strong-write-operations-strong--152","service-v1-core","replace-status-151","read-status-150","patch-status-149","-strong-status-operations-strong--148","watch-list-all-namespaces-147","watch-list-146","watch-145","list-all-namespaces-144","list-143","read-142","-strong-read-operations-strong--141","delete-collection-140","delete-139","replace-138","patch-137","create-136","-strong-write-operations-strong--135","ingress-v1beta1-extensions","watch-list-all-namespaces-134","watch-list-133","watch-132","list-all-namespaces-131","list-130","read-129","-strong-read-operations-strong--128","delete-collection-127","delete-126","replace-125","patch-124","create-123","-strong-write-operations-strong--122","endpoints-v1-core","-strong-discovery-load-balancing-strong-","replace-status-121","read-status-120","patch-status-119","-strong-status-operations-strong--118","watch-list-all-namespaces-117","watch-list-116","watch-115","list-all-namespaces-114","list-113","read-112","-strong-read-operations-strong--111","delete-collection-110","delete-109","replace-108","patch-107","create-106","-strong-write-operations-strong--105","statefulset-v1beta1-apps","replace-status-104","read-status-103","patch-status-102","-strong-status-operations-strong--101","watch-list-all-namespaces-100","watch-list-99","watch-98","list-all-namespaces-97","list-96","read-95","-strong-read-operations-strong--94","delete-collection-93","delete-92","replace-91","patch-90","create-89","-strong-write-operations-strong--88","replicationcontroller-v1-core","replace-status-87","read-status-86","patch-status-85","-strong-status-operations-strong--84","watch-list-all-namespaces-83","watch-list-82","watch-81","list-all-namespaces-80","list-79","read-78","-strong-read-operations-strong--77","delete-collection-76","delete-75","replace-74","patch-73","create-72","-strong-write-operations-strong--71","replicaset-v1beta1-extensions","read-log","-strong-misc-operations-strong-","replace-proxy-path","replace-proxy","replace-connect-proxy-path","replace-connect-proxy","head-connect-proxy-path","head-connect-proxy","get-proxy-path","get-proxy","get-connect-proxy-path","get-connect-proxy","get-connect-portforward","delete-proxy-path","delete-proxy","delete-connect-proxy-path","delete-connect-proxy","create-proxy-path","create-proxy","create-connect-proxy-path","create-connect-proxy","create-connect-portforward","-strong-proxy-operations-strong-","replace-status-70","read-status-69","patch-status-68","-strong-status-operations-strong--67","watch-list-all-namespaces-66","watch-list-65","watch-64","list-all-namespaces-63","list-62","read-61","-strong-read-operations-strong--60","delete-collection-59","delete-58","replace-57","patch-56","create-55","-strong-write-operations-strong--54","pod-v1-core","replace-status-53","read-status-52","patch-status-51","-strong-status-operations-strong--50","watch-list-all-namespaces-49","watch-list-48","watch-47","list-all-namespaces-46","list-45","read-44","-strong-read-operations-strong--43","delete-collection-42","delete-41","replace-40","patch-39","create-38","-strong-write-operations-strong--37","job-v1-batch","replace-status-36","read-status-35","patch-status-34","-strong-status-operations-strong--33","watch-list-all-namespaces-32","watch-list-31","watch-30","list-all-namespaces-29","list-28","read-27","-strong-read-operations-strong--26","delete-collection-25","delete-24","replace-23","patch-22","create-21","-strong-write-operations-strong--20","deployment-v1beta1-apps","replace-status-19","read-status-18","patch-status-17","-strong-status-operations-strong--16","watch-list-all-namespaces-15","watch-list-14","watch-13","list-all-namespaces-12","list-11","read-10","-strong-read-operations-strong--9","delete-collection-8","delete-7","replace-6","patch-5","create-4","-strong-write-operations-strong--3","daemonset-v1beta1-extensions","replace-status","read-status","patch-status","-strong-status-operations-strong-","watch-list-all-namespaces","watch-list","watch","list-all-namespaces","list","read-2","-strong-read-operations-strong-","delete-collection","delete-1","replace","patch","create","-strong-write-operations-strong-","cronjob-v1beta1-batch","container-v1-core","-strong-workloads-strong-","resource-operations","resource-objects","resource-categories","-strong-api-overview-strong-"]};})();
\ No newline at end of file
diff --git a/docs/api-reference/v1.8/node_modules/.bin/marked b/docs/api-reference/v1.8/node_modules/.bin/marked
new file mode 100755
index 0000000000000..64254fc3eb2e0
--- /dev/null
+++ b/docs/api-reference/v1.8/node_modules/.bin/marked
@@ -0,0 +1,187 @@
+#!/usr/bin/env node
+
+/**
+ * Marked CLI
+ * Copyright (c) 2011-2013, Christopher Jeffrey (MIT License)
+ */
+
+var fs = require('fs')
+ , util = require('util')
+ , marked = require('../');
+
+/**
+ * Man Page
+ */
+
+function help() {
+ var spawn = require('child_process').spawn;
+
+ var options = {
+ cwd: process.cwd(),
+ env: process.env,
+ setsid: false,
+ customFds: [0, 1, 2]
+ };
+
+ spawn('man',
+ [__dirname + '/../man/marked.1'],
+ options);
+}
+
+/**
+ * Main
+ */
+
+function main(argv, callback) {
+ var files = []
+ , options = {}
+ , input
+ , output
+ , arg
+ , tokens
+ , opt;
+
+ function getarg() {
+ var arg = argv.shift();
+
+ if (arg.indexOf('--') === 0) {
+ // e.g. --opt
+ arg = arg.split('=');
+ if (arg.length > 1) {
+ // e.g. --opt=val
+ argv.unshift(arg.slice(1).join('='));
+ }
+ arg = arg[0];
+ } else if (arg[0] === '-') {
+ if (arg.length > 2) {
+ // e.g. -abc
+ argv = arg.substring(1).split('').map(function(ch) {
+ return '-' + ch;
+ }).concat(argv);
+ arg = argv.shift();
+ } else {
+ // e.g. -a
+ }
+ } else {
+ // e.g. foo
+ }
+
+ return arg;
+ }
+
+ while (argv.length) {
+ arg = getarg();
+ switch (arg) {
+ case '--test':
+ return require('../test').main(process.argv.slice());
+ case '-o':
+ case '--output':
+ output = argv.shift();
+ break;
+ case '-i':
+ case '--input':
+ input = argv.shift();
+ break;
+ case '-t':
+ case '--tokens':
+ tokens = true;
+ break;
+ case '-h':
+ case '--help':
+ return help();
+ default:
+ if (arg.indexOf('--') === 0) {
+ opt = camelize(arg.replace(/^--(no-)?/, ''));
+ if (!marked.defaults.hasOwnProperty(opt)) {
+ continue;
+ }
+ if (arg.indexOf('--no-') === 0) {
+ options[opt] = typeof marked.defaults[opt] !== 'boolean'
+ ? null
+ : false;
+ } else {
+ options[opt] = typeof marked.defaults[opt] !== 'boolean'
+ ? argv.shift()
+ : true;
+ }
+ } else {
+ files.push(arg);
+ }
+ break;
+ }
+ }
+
+ function getData(callback) {
+ if (!input) {
+ if (files.length <= 2) {
+ return getStdin(callback);
+ }
+ input = files.pop();
+ }
+ return fs.readFile(input, 'utf8', callback);
+ }
+
+ return getData(function(err, data) {
+ if (err) return callback(err);
+
+ data = tokens
+ ? JSON.stringify(marked.lexer(data, options), null, 2)
+ : marked(data, options);
+
+ if (!output) {
+ process.stdout.write(data + '\n');
+ return callback();
+ }
+
+ return fs.writeFile(output, data, callback);
+ });
+}
+
+/**
+ * Helpers
+ */
+
+function getStdin(callback) {
+ var stdin = process.stdin
+ , buff = '';
+
+ stdin.setEncoding('utf8');
+
+ stdin.on('data', function(data) {
+ buff += data;
+ });
+
+ stdin.on('error', function(err) {
+ return callback(err);
+ });
+
+ stdin.on('end', function() {
+ return callback(null, buff);
+ });
+
+ try {
+ stdin.resume();
+ } catch (e) {
+ callback(e);
+ }
+}
+
+function camelize(text) {
+ return text.replace(/(\w)-(\w)/g, function(_, a, b) {
+ return a + b.toUpperCase();
+ });
+}
+
+/**
+ * Expose / Entry Point
+ */
+
+if (!module.parent) {
+ process.title = 'marked';
+ main(process.argv.slice(), function(err, code) {
+ if (err) throw err;
+ return process.exit(code || 0);
+ });
+} else {
+ module.exports = main;
+}
diff --git a/docs/api-reference/v1.8/node_modules/.bin/mime b/docs/api-reference/v1.8/node_modules/.bin/mime
new file mode 100755
index 0000000000000..20b1ffeb2f976
--- /dev/null
+++ b/docs/api-reference/v1.8/node_modules/.bin/mime
@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+
+var mime = require('./mime.js');
+var file = process.argv[2];
+var type = mime.lookup(file);
+
+process.stdout.write(type + '\n');
+
diff --git a/docs/api-reference/v1.8/node_modules/.bin/static b/docs/api-reference/v1.8/node_modules/.bin/static
new file mode 100755
index 0000000000000..b3179fc9b81f5
--- /dev/null
+++ b/docs/api-reference/v1.8/node_modules/.bin/static
@@ -0,0 +1,132 @@
+#!/usr/bin/env node
+
+var fs = require('fs'),
+ path = require('path'),
+ tty = require('tty'),
+ statik = require('./../lib/node-static');
+
+ var argv = require('optimist')
+ .usage([
+ 'USAGE: $0 [-p