Operations
GET /
Description
Get KubeVirt API root paths
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Produces
-
application/json
GET /apis
Description
Get a KubeVirt API GroupList
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Produces
-
application/json
GET /apis/clone.kubevirt.io/
Description
Get a KubeVirt API group
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Produces
-
application/json
GET /apis/clone.kubevirt.io/v1alpha1/
Description
Get KubeVirt API Resources
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Produces
-
application/json
POST /apis/clone.kubevirt.io/v1alpha1/virtualmachineclones
Description
Create a VirtualMachineClone object.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
202 |
Accepted |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
GET /apis/clone.kubevirt.io/v1alpha1/virtualmachineclones
Description
Get a list of VirtualMachineClone objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
DELETE /apis/clone.kubevirt.io/v1alpha1/virtualmachineclones
Description
Delete a collection of VirtualMachineClone objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml
GET /apis/clone.kubevirt.io/v1alpha1/virtualmachineclones/{name}
Description
Get a VirtualMachineClone object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Query |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
boolean |
Query |
export |
Should this value be exported. Export strips fields that a user can not specify. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
PUT /apis/clone.kubevirt.io/v1alpha1/virtualmachineclones/{name}
Description
Update a VirtualMachineClone object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Create |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
DELETE /apis/clone.kubevirt.io/v1alpha1/virtualmachineclones/{name}
Description
Delete a VirtualMachineClone object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Query |
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. |
integer |
Query |
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. |
boolean |
Query |
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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
PATCH /apis/clone.kubevirt.io/v1alpha1/virtualmachineclones/{name}
Description
Patch a VirtualMachineClone object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json-patch+json -
application/merge-patch+json
Produces
-
application/json
GET /apis/clone.kubevirt.io/v1alpha1/watch/virtualmachineclones
Description
Watch a VirtualMachineCloneList object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/export.kubevirt.io/
Description
Get a KubeVirt API group
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Produces
-
application/json
GET /apis/export.kubevirt.io/v1beta1/
Description
Get KubeVirt API Resources
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Produces
-
application/json
POST /apis/export.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachineexports
Description
Create a VirtualMachineExport object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
202 |
Accepted |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
GET /apis/export.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachineexports
Description
Get a list of VirtualMachineExport objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
DELETE /apis/export.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachineexports
Description
Delete a collection of VirtualMachineExport objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml
GET /apis/export.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachineexports/{name}
Description
Get a VirtualMachineExport object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
boolean |
Query |
export |
Should this value be exported. Export strips fields that a user can not specify. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
PUT /apis/export.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachineexports/{name}
Description
Update a VirtualMachineExport object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Create |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
DELETE /apis/export.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachineexports/{name}
Description
Delete a VirtualMachineExport object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
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. |
integer |
Query |
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. |
boolean |
Query |
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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
PATCH /apis/export.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachineexports/{name}
Description
Patch a VirtualMachineExport object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json-patch+json -
application/merge-patch+json
Produces
-
application/json
GET /apis/export.kubevirt.io/v1beta1/virtualmachineexports
Description
Get a list of all VirtualMachineExport objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
GET /apis/export.kubevirt.io/v1beta1/watch/namespaces/{namespace}/virtualmachineexports
Description
Watch a VirtualMachineExport object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/export.kubevirt.io/v1beta1/watch/virtualmachineexports
Description
Watch a VirtualMachineExportList object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/instancetype.kubevirt.io/
Description
Get a KubeVirt API group
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Produces
-
application/json
GET /apis/instancetype.kubevirt.io/v1beta1/
Description
Get KubeVirt API Resources
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Produces
-
application/json
POST /apis/instancetype.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachineinstancetypes
Description
Create a VirtualMachineInstancetype object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
202 |
Accepted |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
GET /apis/instancetype.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachineinstancetypes
Description
Get a list of VirtualMachineInstancetype objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
DELETE /apis/instancetype.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachineinstancetypes
Description
Delete a collection of VirtualMachineInstancetype objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml
GET /apis/instancetype.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachineinstancetypes/{name}
Description
Get a VirtualMachineInstancetype object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
boolean |
Query |
export |
Should this value be exported. Export strips fields that a user can not specify. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
PUT /apis/instancetype.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachineinstancetypes/{name}
Description
Update a VirtualMachineInstancetype object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Create |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
DELETE /apis/instancetype.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachineinstancetypes/{name}
Description
Delete a VirtualMachineInstancetype object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
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. |
integer |
Query |
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. |
boolean |
Query |
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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
PATCH /apis/instancetype.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachineinstancetypes/{name}
Description
Patch a VirtualMachineInstancetype object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json-patch+json -
application/merge-patch+json
Produces
-
application/json
POST /apis/instancetype.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinepreferences
Description
Create a VirtualMachinePreference object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
202 |
Accepted |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
GET /apis/instancetype.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinepreferences
Description
Get a list of VirtualMachinePreference objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
DELETE /apis/instancetype.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinepreferences
Description
Delete a collection of VirtualMachinePreference objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml
GET /apis/instancetype.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinepreferences/{name}
Description
Get a VirtualMachinePreference object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
boolean |
Query |
export |
Should this value be exported. Export strips fields that a user can not specify. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
PUT /apis/instancetype.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinepreferences/{name}
Description
Update a VirtualMachinePreference object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Create |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
DELETE /apis/instancetype.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinepreferences/{name}
Description
Delete a VirtualMachinePreference object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
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. |
integer |
Query |
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. |
boolean |
Query |
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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
PATCH /apis/instancetype.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinepreferences/{name}
Description
Patch a VirtualMachinePreference object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json-patch+json -
application/merge-patch+json
Produces
-
application/json
POST /apis/instancetype.kubevirt.io/v1beta1/virtualmachineclusterinstancetypes
Description
Create a VirtualMachineClusterInstancetype object.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
202 |
Accepted |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
GET /apis/instancetype.kubevirt.io/v1beta1/virtualmachineclusterinstancetypes
Description
Get a list of VirtualMachineClusterInstancetype objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
DELETE /apis/instancetype.kubevirt.io/v1beta1/virtualmachineclusterinstancetypes
Description
Delete a collection of VirtualMachineClusterInstancetype objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml
GET /apis/instancetype.kubevirt.io/v1beta1/virtualmachineclusterinstancetypes/{name}
Description
Get a VirtualMachineClusterInstancetype object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Query |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
boolean |
Query |
export |
Should this value be exported. Export strips fields that a user can not specify. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
PUT /apis/instancetype.kubevirt.io/v1beta1/virtualmachineclusterinstancetypes/{name}
Description
Update a VirtualMachineClusterInstancetype object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Create |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
DELETE /apis/instancetype.kubevirt.io/v1beta1/virtualmachineclusterinstancetypes/{name}
Description
Delete a VirtualMachineClusterInstancetype object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Query |
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. |
integer |
Query |
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. |
boolean |
Query |
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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
PATCH /apis/instancetype.kubevirt.io/v1beta1/virtualmachineclusterinstancetypes/{name}
Description
Patch a VirtualMachineClusterInstancetype object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json-patch+json -
application/merge-patch+json
Produces
-
application/json
POST /apis/instancetype.kubevirt.io/v1beta1/virtualmachineclusterpreferences
Description
Create a VirtualMachineClusterPreference object.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
202 |
Accepted |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
GET /apis/instancetype.kubevirt.io/v1beta1/virtualmachineclusterpreferences
Description
Get a list of VirtualMachineClusterPreference objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
DELETE /apis/instancetype.kubevirt.io/v1beta1/virtualmachineclusterpreferences
Description
Delete a collection of VirtualMachineClusterPreference objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml
GET /apis/instancetype.kubevirt.io/v1beta1/virtualmachineclusterpreferences/{name}
Description
Get a VirtualMachineClusterPreference object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Query |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
boolean |
Query |
export |
Should this value be exported. Export strips fields that a user can not specify. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
PUT /apis/instancetype.kubevirt.io/v1beta1/virtualmachineclusterpreferences/{name}
Description
Update a VirtualMachineClusterPreference object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Create |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
DELETE /apis/instancetype.kubevirt.io/v1beta1/virtualmachineclusterpreferences/{name}
Description
Delete a VirtualMachineClusterPreference object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Query |
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. |
integer |
Query |
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. |
boolean |
Query |
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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
PATCH /apis/instancetype.kubevirt.io/v1beta1/virtualmachineclusterpreferences/{name}
Description
Patch a VirtualMachineClusterPreference object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json-patch+json -
application/merge-patch+json
Produces
-
application/json
GET /apis/instancetype.kubevirt.io/v1beta1/virtualmachineinstancetypes
Description
Get a list of all VirtualMachineInstancetype objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
GET /apis/instancetype.kubevirt.io/v1beta1/virtualmachinepreferences
Description
Get a list of all VirtualMachinePreference objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
GET /apis/instancetype.kubevirt.io/v1beta1/watch/namespaces/{namespace}/virtualmachineinstancetypes
Description
Watch a VirtualMachineInstancetype object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/instancetype.kubevirt.io/v1beta1/watch/namespaces/{namespace}/virtualmachinepreferences
Description
Watch a VirtualMachinePreference object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/instancetype.kubevirt.io/v1beta1/watch/virtualmachineclusterinstancetypes
Description
Watch a VirtualMachineClusterInstancetypeList object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/instancetype.kubevirt.io/v1beta1/watch/virtualmachineclusterpreferences
Description
Watch a VirtualMachineClusterPreferenceList object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/instancetype.kubevirt.io/v1beta1/watch/virtualmachineinstancetypes
Description
Watch a VirtualMachineInstancetypeList object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/instancetype.kubevirt.io/v1beta1/watch/virtualmachinepreferences
Description
Watch a VirtualMachinePreferenceList object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/kubevirt.io/
Description
Get a KubeVirt API group
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Produces
-
application/json
GET /apis/kubevirt.io/v1/
Description
Get KubeVirt API Resources
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Produces
-
application/json
GET /apis/kubevirt.io/v1/kubevirt
Description
Get a list of all KubeVirt objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
POST /apis/kubevirt.io/v1/namespaces/{namespace}/kubevirt
Description
Create a KubeVirt object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
202 |
Accepted |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
GET /apis/kubevirt.io/v1/namespaces/{namespace}/kubevirt
Description
Get a list of KubeVirt objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
DELETE /apis/kubevirt.io/v1/namespaces/{namespace}/kubevirt
Description
Delete a collection of KubeVirt objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml
GET /apis/kubevirt.io/v1/namespaces/{namespace}/kubevirt/{name}
Description
Get a KubeVirt object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
boolean |
Query |
export |
Should this value be exported. Export strips fields that a user can not specify. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
PUT /apis/kubevirt.io/v1/namespaces/{namespace}/kubevirt/{name}
Description
Update a KubeVirt object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Create |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
DELETE /apis/kubevirt.io/v1/namespaces/{namespace}/kubevirt/{name}
Description
Delete a KubeVirt object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
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. |
integer |
Query |
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. |
boolean |
Query |
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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
PATCH /apis/kubevirt.io/v1/namespaces/{namespace}/kubevirt/{name}
Description
Patch a KubeVirt object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json-patch+json -
application/merge-patch+json
Produces
-
application/json
POST /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstancemigrations
Description
Create a VirtualMachineInstanceMigration object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
202 |
Accepted |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
GET /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstancemigrations
Description
Get a list of VirtualMachineInstanceMigration objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
DELETE /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstancemigrations
Description
Delete a collection of VirtualMachineInstanceMigration objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml
GET /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstancemigrations/{name}
Description
Get a VirtualMachineInstanceMigration object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
boolean |
Query |
export |
Should this value be exported. Export strips fields that a user can not specify. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
PUT /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstancemigrations/{name}
Description
Update a VirtualMachineInstanceMigration object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Create |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
DELETE /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstancemigrations/{name}
Description
Delete a VirtualMachineInstanceMigration object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
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. |
integer |
Query |
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. |
boolean |
Query |
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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
PATCH /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstancemigrations/{name}
Description
Patch a VirtualMachineInstanceMigration object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json-patch+json -
application/merge-patch+json
Produces
-
application/json
POST /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstancepresets
Description
Create a VirtualMachineInstancePreset object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
202 |
Accepted |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
GET /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstancepresets
Description
Get a list of VirtualMachineInstancePreset objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
DELETE /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstancepresets
Description
Delete a collection of VirtualMachineInstancePreset objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml
GET /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstancepresets/{name}
Description
Get a VirtualMachineInstancePreset object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
boolean |
Query |
export |
Should this value be exported. Export strips fields that a user can not specify. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
PUT /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstancepresets/{name}
Description
Update a VirtualMachineInstancePreset object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Create |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
DELETE /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstancepresets/{name}
Description
Delete a VirtualMachineInstancePreset object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
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. |
integer |
Query |
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. |
boolean |
Query |
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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
PATCH /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstancepresets/{name}
Description
Patch a VirtualMachineInstancePreset object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json-patch+json -
application/merge-patch+json
Produces
-
application/json
POST /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstancereplicasets
Description
Create a VirtualMachineInstanceReplicaSet object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
202 |
Accepted |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
GET /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstancereplicasets
Description
Get a list of VirtualMachineInstanceReplicaSet objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
DELETE /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstancereplicasets
Description
Delete a collection of VirtualMachineInstanceReplicaSet objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml
GET /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstancereplicasets/{name}
Description
Get a VirtualMachineInstanceReplicaSet object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
boolean |
Query |
export |
Should this value be exported. Export strips fields that a user can not specify. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
PUT /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstancereplicasets/{name}
Description
Update a VirtualMachineInstanceReplicaSet object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Create |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
DELETE /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstancereplicasets/{name}
Description
Delete a VirtualMachineInstanceReplicaSet object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
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. |
integer |
Query |
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. |
boolean |
Query |
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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
PATCH /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstancereplicasets/{name}
Description
Patch a VirtualMachineInstanceReplicaSet object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json-patch+json -
application/merge-patch+json
Produces
-
application/json
POST /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances
Description
Create a VirtualMachineInstance object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
202 |
Accepted |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
GET /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances
Description
Get a list of VirtualMachineInstance objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
DELETE /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances
Description
Delete a collection of VirtualMachineInstance objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml
GET /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}
Description
Get a VirtualMachineInstance object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
boolean |
Query |
export |
Should this value be exported. Export strips fields that a user can not specify. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
PUT /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}
Description
Update a VirtualMachineInstance object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Create |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
DELETE /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}
Description
Delete a VirtualMachineInstance object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
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. |
integer |
Query |
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. |
boolean |
Query |
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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
PATCH /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}
Description
Patch a VirtualMachineInstance object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json-patch+json -
application/merge-patch+json
Produces
-
application/json
POST /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachines
Description
Create a VirtualMachine object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
202 |
Accepted |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
GET /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachines
Description
Get a list of VirtualMachine objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
DELETE /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachines
Description
Delete a collection of VirtualMachine objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml
GET /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachines/{name}
Description
Get a VirtualMachine object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
boolean |
Query |
export |
Should this value be exported. Export strips fields that a user can not specify. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
PUT /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachines/{name}
Description
Update a VirtualMachine object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Create |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
DELETE /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachines/{name}
Description
Delete a VirtualMachine object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
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. |
integer |
Query |
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. |
boolean |
Query |
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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
PATCH /apis/kubevirt.io/v1/namespaces/{namespace}/virtualmachines/{name}
Description
Patch a VirtualMachine object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json-patch+json -
application/merge-patch+json
Produces
-
application/json
GET /apis/kubevirt.io/v1/virtualmachineinstancemigrations
Description
Get a list of all VirtualMachineInstanceMigration objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
GET /apis/kubevirt.io/v1/virtualmachineinstancepresets
Description
Get a list of all VirtualMachineInstancePreset objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
GET /apis/kubevirt.io/v1/virtualmachineinstancereplicasets
Description
Get a list of all VirtualMachineInstanceReplicaSet objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
GET /apis/kubevirt.io/v1/virtualmachineinstances
Description
Get a list of all VirtualMachineInstance objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
GET /apis/kubevirt.io/v1/virtualmachines
Description
Get a list of all VirtualMachine objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
GET /apis/kubevirt.io/v1/watch/kubevirt
Description
Watch a KubeVirtList object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/kubevirt.io/v1/watch/namespaces/{namespace}/kubevirt
Description
Watch a KubeVirt object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/kubevirt.io/v1/watch/namespaces/{namespace}/virtualmachineinstancemigrations
Description
Watch a VirtualMachineInstanceMigration object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/kubevirt.io/v1/watch/namespaces/{namespace}/virtualmachineinstancepresets
Description
Watch a VirtualMachineInstancePreset object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/kubevirt.io/v1/watch/namespaces/{namespace}/virtualmachineinstancereplicasets
Description
Watch a VirtualMachineInstanceReplicaSet object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/kubevirt.io/v1/watch/namespaces/{namespace}/virtualmachineinstances
Description
Watch a VirtualMachineInstance object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/kubevirt.io/v1/watch/namespaces/{namespace}/virtualmachines
Description
Watch a VirtualMachine object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/kubevirt.io/v1/watch/virtualmachineinstancemigrations
Description
Watch a VirtualMachineInstanceMigrationList object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/kubevirt.io/v1/watch/virtualmachineinstancepresets
Description
Watch a VirtualMachineInstancePresetList object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/kubevirt.io/v1/watch/virtualmachineinstancereplicasets
Description
Watch a VirtualMachineInstanceReplicaSetList object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/kubevirt.io/v1/watch/virtualmachineinstances
Description
Watch a VirtualMachineInstanceList object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/kubevirt.io/v1/watch/virtualmachines
Description
Watch a VirtualMachineList object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/migrations.kubevirt.io/
Description
Get a KubeVirt API group
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Produces
-
application/json
GET /apis/migrations.kubevirt.io/v1alpha1/
Description
Get KubeVirt API Resources
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Produces
-
application/json
POST /apis/migrations.kubevirt.io/v1alpha1/migrationpolicies
Description
Create a MigrationPolicy object.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
202 |
Accepted |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
GET /apis/migrations.kubevirt.io/v1alpha1/migrationpolicies
Description
Get a list of MigrationPolicy objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
DELETE /apis/migrations.kubevirt.io/v1alpha1/migrationpolicies
Description
Delete a collection of MigrationPolicy objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml
GET /apis/migrations.kubevirt.io/v1alpha1/migrationpolicies/{name}
Description
Get a MigrationPolicy object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Query |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
boolean |
Query |
export |
Should this value be exported. Export strips fields that a user can not specify. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
PUT /apis/migrations.kubevirt.io/v1alpha1/migrationpolicies/{name}
Description
Update a MigrationPolicy object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Create |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
DELETE /apis/migrations.kubevirt.io/v1alpha1/migrationpolicies/{name}
Description
Delete a MigrationPolicy object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Query |
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. |
integer |
Query |
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. |
boolean |
Query |
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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
PATCH /apis/migrations.kubevirt.io/v1alpha1/migrationpolicies/{name}
Description
Patch a MigrationPolicy object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json-patch+json -
application/merge-patch+json
Produces
-
application/json
GET /apis/migrations.kubevirt.io/v1alpha1/watch/migrationpolicies
Description
Watch a MigrationPolicyList object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/pool.kubevirt.io/
Description
Get a KubeVirt API group
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Produces
-
application/json
GET /apis/pool.kubevirt.io/v1alpha1/
Description
Get KubeVirt API Resources
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Produces
-
application/json
POST /apis/pool.kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinepools
Description
Create a VirtualMachinePool object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
202 |
Accepted |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
GET /apis/pool.kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinepools
Description
Get a list of VirtualMachinePool objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
DELETE /apis/pool.kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinepools
Description
Delete a collection of VirtualMachinePool objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml
GET /apis/pool.kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinepools/{name}
Description
Get a VirtualMachinePool object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
boolean |
Query |
export |
Should this value be exported. Export strips fields that a user can not specify. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
PUT /apis/pool.kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinepools/{name}
Description
Update a VirtualMachinePool object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Create |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
DELETE /apis/pool.kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinepools/{name}
Description
Delete a VirtualMachinePool object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
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. |
integer |
Query |
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. |
boolean |
Query |
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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
PATCH /apis/pool.kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinepools/{name}
Description
Patch a VirtualMachinePool object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json-patch+json -
application/merge-patch+json
Produces
-
application/json
GET /apis/pool.kubevirt.io/v1alpha1/virtualmachinepools
Description
Get a list of all VirtualMachinePool objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
GET /apis/pool.kubevirt.io/v1alpha1/watch/namespaces/{namespace}/virtualmachinepools
Description
Watch a VirtualMachinePool object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/pool.kubevirt.io/v1alpha1/watch/virtualmachinepools
Description
Watch a VirtualMachinePoolList object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/snapshot.kubevirt.io/
Description
Get a KubeVirt API group
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Produces
-
application/json
GET /apis/snapshot.kubevirt.io/v1beta1/
Description
Get KubeVirt API Resources
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Produces
-
application/json
POST /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinerestores
Description
Create a VirtualMachineRestore object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
202 |
Accepted |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
GET /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinerestores
Description
Get a list of VirtualMachineRestore objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
DELETE /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinerestores
Description
Delete a collection of VirtualMachineRestore objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml
GET /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinerestores/{name}
Description
Get a VirtualMachineRestore object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
boolean |
Query |
export |
Should this value be exported. Export strips fields that a user can not specify. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
PUT /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinerestores/{name}
Description
Update a VirtualMachineRestore object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Create |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
DELETE /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinerestores/{name}
Description
Delete a VirtualMachineRestore object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
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. |
integer |
Query |
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. |
boolean |
Query |
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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
PATCH /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinerestores/{name}
Description
Patch a VirtualMachineRestore object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json-patch+json -
application/merge-patch+json
Produces
-
application/json
POST /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinesnapshotcontents
Description
Create a VirtualMachineSnapshotContent object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
202 |
Accepted |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
GET /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinesnapshotcontents
Description
Get a list of VirtualMachineSnapshotContent objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
DELETE /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinesnapshotcontents
Description
Delete a collection of VirtualMachineSnapshotContent objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml
GET /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinesnapshotcontents/{name}
Description
Get a VirtualMachineSnapshotContent object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
boolean |
Query |
export |
Should this value be exported. Export strips fields that a user can not specify. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
PUT /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinesnapshotcontents/{name}
Description
Update a VirtualMachineSnapshotContent object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Create |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
DELETE /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinesnapshotcontents/{name}
Description
Delete a VirtualMachineSnapshotContent object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
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. |
integer |
Query |
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. |
boolean |
Query |
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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
PATCH /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinesnapshotcontents/{name}
Description
Patch a VirtualMachineSnapshotContent object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json-patch+json -
application/merge-patch+json
Produces
-
application/json
POST /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinesnapshots
Description
Create a VirtualMachineSnapshot object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
202 |
Accepted |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
GET /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinesnapshots
Description
Get a list of VirtualMachineSnapshot objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
DELETE /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinesnapshots
Description
Delete a collection of VirtualMachineSnapshot objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml
GET /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinesnapshots/{name}
Description
Get a VirtualMachineSnapshot object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
boolean |
Query |
export |
Should this value be exported. Export strips fields that a user can not specify. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
PUT /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinesnapshots/{name}
Description
Update a VirtualMachineSnapshot object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Create |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
DELETE /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinesnapshots/{name}
Description
Delete a VirtualMachineSnapshot object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
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. |
integer |
Query |
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. |
boolean |
Query |
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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json -
application/yaml
Produces
-
application/json -
application/yaml
PATCH /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinesnapshots/{name}
Description
Patch a VirtualMachineSnapshot object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Consumes
-
application/json-patch+json -
application/merge-patch+json
Produces
-
application/json
GET /apis/snapshot.kubevirt.io/v1beta1/virtualmachinerestores
Description
Get a list of all VirtualMachineRestore objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
GET /apis/snapshot.kubevirt.io/v1beta1/virtualmachinesnapshotcontents
Description
Get a list of all VirtualMachineSnapshotContent objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
GET /apis/snapshot.kubevirt.io/v1beta1/virtualmachinesnapshots
Description
Get a list of all VirtualMachineSnapshot objects.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json -
application/yaml -
application/json;stream=watch
GET /apis/snapshot.kubevirt.io/v1beta1/watch/namespaces/{namespace}/virtualmachinerestores
Description
Watch a VirtualMachineRestore object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/snapshot.kubevirt.io/v1beta1/watch/namespaces/{namespace}/virtualmachinesnapshotcontents
Description
Watch a VirtualMachineSnapshotContent object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/snapshot.kubevirt.io/v1beta1/watch/namespaces/{namespace}/virtualmachinesnapshots
Description
Watch a VirtualMachineSnapshot object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/snapshot.kubevirt.io/v1beta1/watch/virtualmachinerestores
Description
Watch a VirtualMachineRestoreList object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/snapshot.kubevirt.io/v1beta1/watch/virtualmachinesnapshotcontents
Description
Watch a VirtualMachineSnapshotContentList object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/snapshot.kubevirt.io/v1beta1/watch/virtualmachinesnapshots
Description
Watch a VirtualMachineSnapshotList object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
includeUninitialized |
If true, partially initialized resources are included in the response. |
boolean |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
integer |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Query |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
string |
Produces
-
application/json
GET /apis/subresources.kubevirt.io
Description
Get a KubeVirt API Group
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Produces
-
application/json
GET /apis/subresources.kubevirt.io/v1/
Description
Get a KubeVirt API resources
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Produces
-
application/json
GET /apis/subresources.kubevirt.io/v1/dump-cluster-profiler
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
Produces
-
application/json
GET /apis/subresources.kubevirt.io/v1/guestfs
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
Produces
-
application/json
GET /apis/subresources.kubevirt.io/v1/healthz
Description
Health endpoint
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
500 |
Unhealthy |
string |
Consumes
-
application/json
Produces
-
application/json
PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/expand-vm-spec
Description
Expands instancetype and preference into the passed VirtualMachine object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
string |
Consumes
-
application/json
Produces
-
application/json
PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/addvolume
Description
Add a volume and disk to a running Virtual Machine Instance
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
Consumes
-
*/*
GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/console
Description
Open a websocket connection to a serial console on the specified VirtualMachineInstance.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/filesystemlist
Description
Get list of active filesystems on guest machine via guest agent
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
Consumes
-
application/json
Produces
-
application/json
PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/freeze
Description
Freeze a VirtualMachineInstance object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
string |
Consumes
-
*/*
GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/guestosinfo
Description
Get guest agent os information
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
Consumes
-
application/json
Produces
-
application/json
PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/pause
Description
Pause a VirtualMachineInstance object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Consumes
-
*/*
GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/portforward/{port}
Description
Open a websocket connection forwarding traffic to the specified VirtualMachineInstance and port.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Path |
port |
The target port for portforward on the VirtualMachineInstance. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/portforward/{port}/{protocol}
Description
Open a websocket connection forwarding traffic of the specified protocol (either tcp or udp) to the specified VirtualMachineInstance and port.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Path |
port |
The target port for portforward on the VirtualMachineInstance. |
string |
Path |
protocol |
The protocol for portforward on the VirtualMachineInstance. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/removevolume
Description
Removes a volume and disk from a running Virtual Machine Instance
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
Consumes
-
*/*
GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/sev/fetchcertchain
Description
Fetch SEV certificate chain from the node where Virtual Machine is scheduled
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
Consumes
-
application/json
Produces
-
application/json
PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/sev/injectlaunchsecret
Description
Inject SEV launch secret into a Virtual Machine
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
Consumes
-
*/*
GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/sev/querylaunchmeasurement
Description
Query SEV launch measurement from a Virtual Machine
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
Consumes
-
application/json
Produces
-
application/json
PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/sev/setupsession
Description
Setup SEV session parameters for a Virtual Machine
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
Consumes
-
*/*
PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/softreboot
Description
Soft reboot a VirtualMachineInstance object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
string |
PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/unfreeze
Description
Unfreeze a VirtualMachineInstance object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
string |
PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/unpause
Description
Unpause a VirtualMachineInstance object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Consumes
-
*/*
GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/usbredir
Description
Open a websocket connection to connect to USB device on the specified VirtualMachineInstance.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/userlist
Description
Get list of active users via guest agent
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
Consumes
-
application/json
Produces
-
application/json
GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/vnc
Description
Open a websocket connection to connect to VNC on the specified VirtualMachineInstance.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/vnc/screenshot
Description
Get a PNG VNC screenshot of the specified VirtualMachineInstance.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
moveCursor |
Move the cursor on the VNC display to wake up the screen |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachineinstances/{name}/vsock
Description
Open a websocket connection forwarding traffic to the specified VirtualMachineInstance and port via VSOCK.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
port |
The port which the VSOCK application listens to. |
integer |
Query |
tls |
Weather to request a TLS encrypted session from the VSOCK application. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachines/{name}/addvolume
Description
Add a volume and disk to a running Virtual Machine.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
Consumes
-
*/*
GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachines/{name}/expand-spec
Description
Get VirtualMachine object with expanded instancetype and preference.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
500 |
Internal Server Error |
string |
Produces
-
application/json
PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachines/{name}/memorydump
Description
Dumps a VirtualMachineInstance memory.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
string |
Consumes
-
*/*
PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachines/{name}/migrate
Description
Migrate a running VirtualMachine to another node.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Consumes
-
*/*
GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachines/{name}/portforward/{port}
Description
Open a websocket connection forwarding traffic to the running VMI for the specified VirtualMachine and port.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Path |
port |
The target port for portforward on the VirtualMachineInstance. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachines/{name}/portforward/{port}/{protocol}
Description
Open a websocket connection forwarding traffic of the specified protocol (either tcp or udp) to the specified VirtualMachine and port.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Path |
port |
The target port for portforward on the VirtualMachineInstance. |
string |
Path |
protocol |
The protocol for portforward on the VirtualMachineInstance. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachines/{name}/removememorydump
Description
Remove memory dump association.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
string |
PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachines/{name}/removevolume
Description
Removes a volume and disk from a running Virtual Machine.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
Consumes
-
*/*
PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachines/{name}/restart
Description
Restart a VirtualMachine object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Consumes
-
*/*
PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachines/{name}/start
Description
Start a VirtualMachine object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Consumes
-
*/*
PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace}/virtualmachines/{name}/stop
Description
Stop a VirtualMachine object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Consumes
-
*/*
GET /apis/subresources.kubevirt.io/v1/start-cluster-profiler
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
Produces
-
application/json
GET /apis/subresources.kubevirt.io/v1/stop-cluster-profiler
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
Produces
-
application/json
GET /apis/subresources.kubevirt.io/v1/version
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
Produces
-
application/json
GET /apis/subresources.kubevirt.io/v1alpha3/
Description
Get a KubeVirt API resources
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Produces
-
application/json
GET /apis/subresources.kubevirt.io/v1alpha3/dump-cluster-profiler
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
Produces
-
application/json
GET /apis/subresources.kubevirt.io/v1alpha3/guestfs
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
Produces
-
application/json
GET /apis/subresources.kubevirt.io/v1alpha3/healthz
Description
Health endpoint
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
500 |
Unhealthy |
string |
Consumes
-
application/json
Produces
-
application/json
PUT /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/expand-vm-spec
Description
Expands instancetype and preference into the passed VirtualMachine object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
string |
Consumes
-
application/json
Produces
-
application/json
PUT /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachineinstances/{name}/addvolume
Description
Add a volume and disk to a running Virtual Machine Instance
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
Consumes
-
*/*
GET /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachineinstances/{name}/console
Description
Open a websocket connection to a serial console on the specified VirtualMachineInstance.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
GET /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachineinstances/{name}/filesystemlist
Description
Get list of active filesystems on guest machine via guest agent
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
Consumes
-
application/json
Produces
-
application/json
PUT /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachineinstances/{name}/freeze
Description
Freeze a VirtualMachineInstance object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
string |
Consumes
-
*/*
GET /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachineinstances/{name}/guestosinfo
Description
Get guest agent os information
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
Consumes
-
application/json
Produces
-
application/json
PUT /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachineinstances/{name}/pause
Description
Pause a VirtualMachineInstance object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Consumes
-
*/*
GET /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachineinstances/{name}/portforward/{port}
Description
Open a websocket connection forwarding traffic to the specified VirtualMachineInstance and port.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Path |
port |
The target port for portforward on the VirtualMachineInstance. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
GET /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachineinstances/{name}/portforward/{port}/{protocol}
Description
Open a websocket connection forwarding traffic of the specified protocol (either tcp or udp) to the specified VirtualMachineInstance and port.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Path |
port |
The target port for portforward on the VirtualMachineInstance. |
string |
Path |
protocol |
The protocol for portforward on the VirtualMachineInstance. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
PUT /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachineinstances/{name}/removevolume
Description
Removes a volume and disk from a running Virtual Machine Instance
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
Consumes
-
*/*
GET /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachineinstances/{name}/sev/fetchcertchain
Description
Fetch SEV certificate chain from the node where Virtual Machine is scheduled
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
Consumes
-
application/json
Produces
-
application/json
PUT /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachineinstances/{name}/sev/injectlaunchsecret
Description
Inject SEV launch secret into a Virtual Machine
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
Consumes
-
*/*
GET /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachineinstances/{name}/sev/querylaunchmeasurement
Description
Query SEV launch measurement from a Virtual Machine
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
Consumes
-
application/json
Produces
-
application/json
PUT /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachineinstances/{name}/sev/setupsession
Description
Setup SEV session parameters for a Virtual Machine
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
Consumes
-
*/*
PUT /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachineinstances/{name}/softreboot
Description
Soft reboot a VirtualMachineInstance object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
string |
PUT /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachineinstances/{name}/unfreeze
Description
Unfreeze a VirtualMachineInstance object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
string |
PUT /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachineinstances/{name}/unpause
Description
Unpause a VirtualMachineInstance object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Consumes
-
*/*
GET /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachineinstances/{name}/usbredir
Description
Open a websocket connection to connect to USB device on the specified VirtualMachineInstance.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
GET /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachineinstances/{name}/userlist
Description
Get list of active users via guest agent
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
Consumes
-
application/json
Produces
-
application/json
GET /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachineinstances/{name}/vnc
Description
Open a websocket connection to connect to VNC on the specified VirtualMachineInstance.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
GET /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachineinstances/{name}/vnc/screenshot
Description
Get a PNG VNC screenshot of the specified VirtualMachineInstance.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
moveCursor |
Move the cursor on the VNC display to wake up the screen |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
GET /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachineinstances/{name}/vsock
Description
Open a websocket connection forwarding traffic to the specified VirtualMachineInstance and port via VSOCK.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
port |
The port which the VSOCK application listens to. |
integer |
Query |
tls |
Weather to request a TLS encrypted session from the VSOCK application. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
PUT /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachines/{name}/addvolume
Description
Add a volume and disk to a running Virtual Machine.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
Consumes
-
*/*
GET /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachines/{name}/expand-spec
Description
Get VirtualMachine object with expanded instancetype and preference.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
500 |
Internal Server Error |
string |
Produces
-
application/json
PUT /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachines/{name}/memorydump
Description
Dumps a VirtualMachineInstance memory.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
string |
Consumes
-
*/*
PUT /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachines/{name}/migrate
Description
Migrate a running VirtualMachine to another node.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Consumes
-
*/*
GET /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachines/{name}/portforward/{port}
Description
Open a websocket connection forwarding traffic to the running VMI for the specified VirtualMachine and port.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Path |
port |
The target port for portforward on the VirtualMachineInstance. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
GET /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachines/{name}/portforward/{port}/{protocol}
Description
Open a websocket connection forwarding traffic of the specified protocol (either tcp or udp) to the specified VirtualMachine and port.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Path |
port |
The target port for portforward on the VirtualMachineInstance. |
string |
Path |
protocol |
The protocol for portforward on the VirtualMachineInstance. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
PUT /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachines/{name}/removememorydump
Description
Remove memory dump association.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
string |
PUT /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachines/{name}/removevolume
Description
Removes a volume and disk from a running Virtual Machine.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
Consumes
-
*/*
PUT /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachines/{name}/restart
Description
Restart a VirtualMachine object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Consumes
-
*/*
PUT /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachines/{name}/start
Description
Start a VirtualMachine object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Consumes
-
*/*
PUT /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace}/virtualmachines/{name}/stop
Description
Stop a VirtualMachine object.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
string |
401 |
Unauthorized |
No Content |
404 |
Not Found |
string |
Consumes
-
*/*
GET /apis/subresources.kubevirt.io/v1alpha3/start-cluster-profiler
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
Produces
-
application/json
GET /apis/subresources.kubevirt.io/v1alpha3/stop-cluster-profiler
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
Produces
-
application/json
GET /apis/subresources.kubevirt.io/v1alpha3/version
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
Produces
-
application/json
GET /dump-profiler
Description
dump profiler results endpoint
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
GET /healthz
Description
Health endpoint
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
GET /openapi/v2
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
Consumes
-
application/json
Produces
-
application/json
GET /start-profiler
Description
start profiler endpoint
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |
GET /stop-profiler
Description
stop profiler endpoint
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Unauthorized |
No Content |