Operations
Get a KubeVirt API GroupList
GET /apis
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
default |
OK |
Produces
-
application/json
Get a KubeVirt API group
GET /apis/kubevirt.io
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
default |
OK |
Produces
-
application/json
Get KubeVirt API Resources
GET /apis/kubevirt.io/v1alpha2
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
default |
OK |
Produces
-
application/json
Health endpoint
GET /apis/kubevirt.io/v1alpha2/healthz
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
No Content |
500 |
Unhealthy |
No Content |
default |
OK |
No Content |
Consumes
-
application/json
Produces
-
application/json
Create a VirtualMachineInstancePreset object.
POST /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachineinstancepresets
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 |
No Content |
default |
OK |
Consumes
-
application/json
-
application/yaml
Produces
-
application/json
-
application/yaml
Get a list of VirtualMachineInstancePreset objects.
GET /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachineinstancepresets
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 |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
-
application/json;stream=watch
Delete a collection of VirtualMachineInstancePreset objects.
DELETE /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachineinstancepresets
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 |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
Get a VirtualMachineInstancePreset object.
GET /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachineinstancepresets/{name}
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 |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
-
application/json;stream=watch
Update a VirtualMachineInstancePreset object.
PUT /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachineinstancepresets/{name}
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 |
No Content |
default |
OK |
Consumes
-
application/json
-
application/yaml
Produces
-
application/json
-
application/yaml
Delete a VirtualMachineInstancePreset object.
DELETE /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachineinstancepresets/{name}
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 |
No Content |
default |
OK |
Consumes
-
application/json
-
application/yaml
Produces
-
application/json
-
application/yaml
Patch a VirtualMachineInstancePreset object.
PATCH /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachineinstancepresets/{name}
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 |
No Content |
default |
OK |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
Produces
-
application/json
Create a VirtualMachineInstanceReplicaSet object.
POST /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachineinstancereplicasets
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 |
No Content |
default |
OK |
Consumes
-
application/json
-
application/yaml
Produces
-
application/json
-
application/yaml
Get a list of VirtualMachineInstanceReplicaSet objects.
GET /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachineinstancereplicasets
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 |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
-
application/json;stream=watch
Delete a collection of VirtualMachineInstanceReplicaSet objects.
DELETE /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachineinstancereplicasets
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 |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
Get a VirtualMachineInstanceReplicaSet object.
GET /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachineinstancereplicasets/{name}
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 |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
-
application/json;stream=watch
Update a VirtualMachineInstanceReplicaSet object.
PUT /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachineinstancereplicasets/{name}
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 |
No Content |
default |
OK |
Consumes
-
application/json
-
application/yaml
Produces
-
application/json
-
application/yaml
Delete a VirtualMachineInstanceReplicaSet object.
DELETE /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachineinstancereplicasets/{name}
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 |
No Content |
default |
OK |
Consumes
-
application/json
-
application/yaml
Produces
-
application/json
-
application/yaml
Patch a VirtualMachineInstanceReplicaSet object.
PATCH /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachineinstancereplicasets/{name}
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 |
No Content |
default |
OK |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
Produces
-
application/json
Create a VirtualMachineInstance object.
POST /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachineinstances
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 |
No Content |
default |
OK |
Consumes
-
application/json
-
application/yaml
Produces
-
application/json
-
application/yaml
Get a list of VirtualMachineInstance objects.
GET /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachineinstances
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 |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
-
application/json;stream=watch
Delete a collection of VirtualMachineInstance objects.
DELETE /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachineinstances
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 |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
Get a VirtualMachineInstance object.
GET /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachineinstances/{name}
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 |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
-
application/json;stream=watch
Update a VirtualMachineInstance object.
PUT /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachineinstances/{name}
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 |
No Content |
default |
OK |
Consumes
-
application/json
-
application/yaml
Produces
-
application/json
-
application/yaml
Delete a VirtualMachineInstance object.
DELETE /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachineinstances/{name}
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 |
No Content |
default |
OK |
Consumes
-
application/json
-
application/yaml
Produces
-
application/json
-
application/yaml
Patch a VirtualMachineInstance object.
PATCH /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachineinstances/{name}
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 |
No Content |
default |
OK |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
Produces
-
application/json
Create a VirtualMachine object.
POST /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachines
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 |
No Content |
default |
OK |
Consumes
-
application/json
-
application/yaml
Produces
-
application/json
-
application/yaml
Get a list of VirtualMachine objects.
GET /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachines
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 |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
-
application/json;stream=watch
Delete a collection of VirtualMachine objects.
DELETE /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachines
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 |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
Get a VirtualMachine object.
GET /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachines/{name}
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 |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
-
application/json;stream=watch
Update a VirtualMachine object.
PUT /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachines/{name}
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 |
No Content |
default |
OK |
Consumes
-
application/json
-
application/yaml
Produces
-
application/json
-
application/yaml
Delete a VirtualMachine object.
DELETE /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachines/{name}
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 |
No Content |
default |
OK |
Consumes
-
application/json
-
application/yaml
Produces
-
application/json
-
application/yaml
Patch a VirtualMachine object.
PATCH /apis/kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachines/{name}
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 |
No Content |
default |
OK |
Consumes
-
application/json-patch+json
-
application/merge-patch+json
Produces
-
application/json
Get a list of all VirtualMachineInstancePreset objects.
GET /apis/kubevirt.io/v1alpha2/virtualmachineinstancepresets
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 |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
-
application/json;stream=watch
Get a list of all VirtualMachineInstanceReplicaSet objects.
GET /apis/kubevirt.io/v1alpha2/virtualmachineinstancereplicasets
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 |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
-
application/json;stream=watch
Get a list of all VirtualMachineInstance objects.
GET /apis/kubevirt.io/v1alpha2/virtualmachineinstances
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 |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
-
application/json;stream=watch
Get a list of all VirtualMachine objects.
GET /apis/kubevirt.io/v1alpha2/virtualmachines
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 |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
-
application/json;stream=watch
Watch a VirtualMachineInstancePreset object.
GET /apis/kubevirt.io/v1alpha2/watch/namespaces/{namespace}/virtualmachineinstancepresets
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 |
No Content |
default |
OK |
Produces
-
application/json
Watch a VirtualMachineInstanceReplicaSet object.
GET /apis/kubevirt.io/v1alpha2/watch/namespaces/{namespace}/virtualmachineinstancereplicasets
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 |
No Content |
default |
OK |
Produces
-
application/json
Watch a VirtualMachineInstance object.
GET /apis/kubevirt.io/v1alpha2/watch/namespaces/{namespace}/virtualmachineinstances
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 |
No Content |
default |
OK |
Produces
-
application/json
Watch a VirtualMachine object.
GET /apis/kubevirt.io/v1alpha2/watch/namespaces/{namespace}/virtualmachines
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 |
No Content |
default |
OK |
Produces
-
application/json
Watch a VirtualMachineInstancePresetList object.
GET /apis/kubevirt.io/v1alpha2/watch/virtualmachineinstancepresets
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 |
No Content |
default |
OK |
Produces
-
application/json
Watch a VirtualMachineInstanceReplicaSetList object.
GET /apis/kubevirt.io/v1alpha2/watch/virtualmachineinstancereplicasets
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 |
No Content |
default |
OK |
Produces
-
application/json
Watch a VirtualMachineInstanceList object.
GET /apis/kubevirt.io/v1alpha2/watch/virtualmachineinstances
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 |
No Content |
default |
OK |
Produces
-
application/json
Watch a VirtualMachineList object.
GET /apis/kubevirt.io/v1alpha2/watch/virtualmachines
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 |
No Content |
default |
OK |
Produces
-
application/json
Get a KubeVirt API Group
GET /apis/subresources.kubevirt.io
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
default |
OK |
Produces
-
application/json
Get a KubeVirt API resources
GET /apis/subresources.kubevirt.io/v1alpha2
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
default |
OK |
Produces
-
application/json
Open a websocket connection to a serial console on the specified VirtualMachineInstance.
GET /apis/subresources.kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachineinstances/{name}/console
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 |
No Content |
Test endpoint verifying apiserver connectivity.
GET /apis/subresources.kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachineinstances/{name}/test
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 |
No Content |
Open a websocket connection to connect to VNC on the specified VirtualMachineInstance.
GET /apis/subresources.kubevirt.io/v1alpha2/namespaces/{namespace}/virtualmachineinstances/{name}/vnc
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 |
No Content |
GET /apis/subresources.kubevirt.io/v1alpha2/version
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
No Content |
Produces
-
application/json