Operations

Responses

HTTP Code	Description	Schema
200	OK	v1.VirtualMachineInstanceMigration
201	Created	v1.VirtualMachineInstanceMigration
202	Accepted	v1.VirtualMachineInstanceMigration
401	Unauthorized	string

HTTP Code

Description

Schema

200

OK

201

Created

202

Accepted

v1.VirtualMachineInstanceMigrationList

401

Unauthorized

string

Consumes

application/json
application/yaml

Produces

application/json
application/yaml

GET /apis/kubevirt.io/v1alpha3/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachineinstancemigrations

Description

Get a list of VirtualMachineInstanceMigration objects.

Parameters

Type Name Description Schema

Type	Name	Description	Schema
Path	namespace required	Object name and auth scope, such as for teams and projects	string
Query	continue optional	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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 optional	A selector to restrict the list of returned objects by their fields. Defaults to everything.	string
Query	includeUninitialized optional	If true, partially initialized resources are included in the response.	boolean
Query	labelSelector optional	A selector to restrict the list of returned objects by their labels. Defaults to everything	string
Query	limit optional	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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 optional	When 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 optional	TimeoutSeconds for the list/watch call.	integer
Query	watch optional	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	boolean

Path

namespace
required

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

string

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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	v1.VirtualMachineInstanceMigrationList
401	Unauthorized	string

HTTP Code

Description

Schema

200

OK

401

Unauthorized

string

Produces

application/json
application/yaml
application/json;stream=watch

DELETE /apis/kubevirt.io/v1alpha3/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachineinstancemigrations

Description

Delete a collection of VirtualMachineInstanceMigration objects.

Parameters

Type Name Description Schema

Type	Name	Description	Schema
Query	continue optional	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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 optional	A selector to restrict the list of returned objects by their fields. Defaults to everything.	string
Query	includeUninitialized optional	If true, partially initialized resources are included in the response.	boolean
Query	labelSelector optional	A selector to restrict the list of returned objects by their labels. Defaults to everything	string
Query	limit optional	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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 optional	When 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 optional	TimeoutSeconds for the list/watch call.	integer
Query	watch optional	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	boolean

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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	v1.Status
401	Unauthorized	string

HTTP Code

Description

Schema

200

OK

401

Unauthorized

string

Produces

application/json
application/yaml

GET /apis/kubevirt.io/v1alpha3/namespaces/{namespace:[a-z0-9]}/virtualmachineinstancemigrations/{name:[a-z0-9][a-z0-9\-]}

Description

Get a VirtualMachineInstanceMigration object.

Parameters

Type	Name	Description	Schema
Path	name required	Name of the resource	string
Path	namespace required	Object name and auth scope, such as for teams and projects	string
Query	exact optional	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.	boolean
Query	export optional	Should this value be exported. Export strips fields that a user can not specify.	boolean

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Query

exact
optional

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

boolean

Query

export
optional

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

boolean

Responses

HTTP Code	Description	Schema
200	OK	v1.VirtualMachineInstanceMigration
401	Unauthorized	string

HTTP Code

Description

Schema

200

OK

401

Unauthorized

string

Produces

application/json
application/yaml
application/json;stream=watch

PUT /apis/kubevirt.io/v1alpha3/namespaces/{namespace:[a-z0-9]}/virtualmachineinstancemigrations/{name:[a-z0-9][a-z0-9\-]}

Description

Update a VirtualMachineInstanceMigration object.

Parameters

Type	Name	Description	Schema
Path	name required	Name of the resource	string
Path	namespace required	Object name and auth scope, such as for teams and projects	string
Body	body required		v1.VirtualMachineInstanceMigration

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Body

body
required

Responses

HTTP Code	Description	Schema
200	OK	v1.VirtualMachineInstanceMigration
201	Create	v1.VirtualMachineInstanceMigration
401	Unauthorized	string

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/v1alpha3/namespaces/{namespace:[a-z0-9]}/virtualmachineinstancemigrations/{name:[a-z0-9][a-z0-9\-]}

Description

Delete a VirtualMachineInstanceMigration object.

Parameters

Type	Name	Description	Schema
Path	name required	Name of the resource	string
Path	namespace required	Object name and auth scope, such as for teams and projects	string
Query	gracePeriodSeconds optional	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 optional	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 optional	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 required		v1.DeleteOptions

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Query

gracePeriodSeconds
optional

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
optional

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
optional

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
required

Responses

HTTP Code	Description	Schema
200	OK	v1.Status
401	Unauthorized	string

HTTP Code

Description

Schema

200

OK

401

Unauthorized

string

Consumes

application/json
application/yaml

Produces

application/json
application/yaml

PATCH /apis/kubevirt.io/v1alpha3/namespaces/{namespace:[a-z0-9]}/virtualmachineinstancemigrations/{name:[a-z0-9][a-z0-9\-]}

Description

Patch a VirtualMachineInstanceMigration object.

Parameters

Type	Name	Description	Schema
Path	name required	Name of the resource	string
Path	namespace required	Object name and auth scope, such as for teams and projects	string
Body	body required		v1.Patch

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Body

body
required

Responses

HTTP Code	Description	Schema
200	OK	v1.VirtualMachineInstanceMigration
401	Unauthorized	string

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/v1alpha3/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachineinstancepresets

Description

Create a VirtualMachineInstancePreset object.

Parameters

Type	Name	Description	Schema
Path	namespace required	Object name and auth scope, such as for teams and projects	string
Body	body required		v1.VirtualMachineInstancePreset

Type

Name

Description

Schema

Path

namespace
required

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

string

Body

body
required

Responses

HTTP Code	Description	Schema
200	OK	v1.VirtualMachineInstancePreset
201	Created	v1.VirtualMachineInstancePreset
202	Accepted	v1.VirtualMachineInstancePreset
401	Unauthorized	string

HTTP Code

Description

Schema

200

OK

201

Created

202

Accepted

v1.VirtualMachineInstancePresetList

401

Unauthorized

string

Consumes

application/json
application/yaml

Produces

application/json
application/yaml

GET /apis/kubevirt.io/v1alpha3/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachineinstancepresets

Description

Get a list of VirtualMachineInstancePreset objects.

Parameters

Type Name Description Schema

Type	Name	Description	Schema
Path	namespace required	Object name and auth scope, such as for teams and projects	string
Query	continue optional	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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 optional	A selector to restrict the list of returned objects by their fields. Defaults to everything.	string
Query	includeUninitialized optional	If true, partially initialized resources are included in the response.	boolean
Query	labelSelector optional	A selector to restrict the list of returned objects by their labels. Defaults to everything	string
Query	limit optional	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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 optional	When 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 optional	TimeoutSeconds for the list/watch call.	integer
Query	watch optional	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	boolean

Path

namespace
required

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

string

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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	v1.VirtualMachineInstancePresetList
401	Unauthorized	string

HTTP Code

Description

Schema

200

OK

401

Unauthorized

string

Produces

application/json
application/yaml
application/json;stream=watch

DELETE /apis/kubevirt.io/v1alpha3/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachineinstancepresets

Description

Delete a collection of VirtualMachineInstancePreset objects.

Parameters

Type Name Description Schema

Type	Name	Description	Schema
Query	continue optional	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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 optional	A selector to restrict the list of returned objects by their fields. Defaults to everything.	string
Query	includeUninitialized optional	If true, partially initialized resources are included in the response.	boolean
Query	labelSelector optional	A selector to restrict the list of returned objects by their labels. Defaults to everything	string
Query	limit optional	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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 optional	When 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 optional	TimeoutSeconds for the list/watch call.	integer
Query	watch optional	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	boolean

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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	v1.Status
401	Unauthorized	string

HTTP Code

Description

Schema

200

OK

401

Unauthorized

string

Produces

application/json
application/yaml

GET /apis/kubevirt.io/v1alpha3/namespaces/{namespace:[a-z0-9]}/virtualmachineinstancepresets/{name:[a-z0-9][a-z0-9\-]}

Description

Get a VirtualMachineInstancePreset object.

Parameters

Type	Name	Description	Schema
Path	name required	Name of the resource	string
Path	namespace required	Object name and auth scope, such as for teams and projects	string
Query	exact optional	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.	boolean
Query	export optional	Should this value be exported. Export strips fields that a user can not specify.	boolean

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Query

exact
optional

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

boolean

Query

export
optional

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

boolean

Responses

HTTP Code	Description	Schema
200	OK	v1.VirtualMachineInstancePreset
401	Unauthorized	string

HTTP Code

Description

Schema

200

OK

401

Unauthorized

string

Produces

application/json
application/yaml
application/json;stream=watch

PUT /apis/kubevirt.io/v1alpha3/namespaces/{namespace:[a-z0-9]}/virtualmachineinstancepresets/{name:[a-z0-9][a-z0-9\-]}

Description

Update a VirtualMachineInstancePreset object.

Parameters

Type	Name	Description	Schema
Path	name required	Name of the resource	string
Path	namespace required	Object name and auth scope, such as for teams and projects	string
Body	body required		v1.VirtualMachineInstancePreset

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Body

body
required

Responses

HTTP Code	Description	Schema
200	OK	v1.VirtualMachineInstancePreset
201	Create	v1.VirtualMachineInstancePreset
401	Unauthorized	string

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/v1alpha3/namespaces/{namespace:[a-z0-9]}/virtualmachineinstancepresets/{name:[a-z0-9][a-z0-9\-]}

Description

Delete a VirtualMachineInstancePreset object.

Parameters

Type	Name	Description	Schema
Path	name required	Name of the resource	string
Path	namespace required	Object name and auth scope, such as for teams and projects	string
Query	gracePeriodSeconds optional	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 optional	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 optional	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 required		v1.DeleteOptions

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Query

gracePeriodSeconds
optional

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
optional

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
optional

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
required

Responses

HTTP Code	Description	Schema
200	OK	v1.Status
401	Unauthorized	string

HTTP Code

Description

Schema

200

OK

401

Unauthorized

string

Consumes

application/json
application/yaml

Produces

application/json
application/yaml

PATCH /apis/kubevirt.io/v1alpha3/namespaces/{namespace:[a-z0-9]}/virtualmachineinstancepresets/{name:[a-z0-9][a-z0-9\-]}

Description

Patch a VirtualMachineInstancePreset object.

Parameters

Type	Name	Description	Schema
Path	name required	Name of the resource	string
Path	namespace required	Object name and auth scope, such as for teams and projects	string
Body	body required		v1.Patch

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Body

body
required

Responses

HTTP Code	Description	Schema
200	OK	v1.VirtualMachineInstancePreset
401	Unauthorized	string

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/v1alpha3/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachineinstancereplicasets

Description

Create a VirtualMachineInstanceReplicaSet object.

Parameters

Type	Name	Description	Schema
Path	namespace required	Object name and auth scope, such as for teams and projects	string
Body	body required		v1.VirtualMachineInstanceReplicaSet

Type

Name

Description

Schema

Path

namespace
required

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

string

Body

body
required

Responses

HTTP Code	Description	Schema
200	OK	v1.VirtualMachineInstanceReplicaSet
201	Created	v1.VirtualMachineInstanceReplicaSet
202	Accepted	v1.VirtualMachineInstanceReplicaSet
401	Unauthorized	string

HTTP Code

Description

Schema

200

OK

201

Created

202

Accepted

v1.VirtualMachineInstanceReplicaSetList

401

Unauthorized

string

Consumes

application/json
application/yaml

Produces

application/json
application/yaml

GET /apis/kubevirt.io/v1alpha3/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachineinstancereplicasets

Description

Get a list of VirtualMachineInstanceReplicaSet objects.

Parameters

Type Name Description Schema

Type	Name	Description	Schema
Path	namespace required	Object name and auth scope, such as for teams and projects	string
Query	continue optional	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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 optional	A selector to restrict the list of returned objects by their fields. Defaults to everything.	string
Query	includeUninitialized optional	If true, partially initialized resources are included in the response.	boolean
Query	labelSelector optional	A selector to restrict the list of returned objects by their labels. Defaults to everything	string
Query	limit optional	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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 optional	When 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 optional	TimeoutSeconds for the list/watch call.	integer
Query	watch optional	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	boolean

Path

namespace
required

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

string

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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	v1.VirtualMachineInstanceReplicaSetList
401	Unauthorized	string

HTTP Code

Description

Schema

200

OK

401

Unauthorized

string

Produces

application/json
application/yaml
application/json;stream=watch

DELETE /apis/kubevirt.io/v1alpha3/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachineinstancereplicasets

Description

Delete a collection of VirtualMachineInstanceReplicaSet objects.

Parameters

Type Name Description Schema

Type	Name	Description	Schema
Query	continue optional	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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 optional	A selector to restrict the list of returned objects by their fields. Defaults to everything.	string
Query	includeUninitialized optional	If true, partially initialized resources are included in the response.	boolean
Query	labelSelector optional	A selector to restrict the list of returned objects by their labels. Defaults to everything	string
Query	limit optional	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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 optional	When 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 optional	TimeoutSeconds for the list/watch call.	integer
Query	watch optional	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	boolean

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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	v1.Status
401	Unauthorized	string

HTTP Code

Description

Schema

200

OK

401

Unauthorized

string

Produces

application/json
application/yaml

GET /apis/kubevirt.io/v1alpha3/namespaces/{namespace:[a-z0-9]}/virtualmachineinstancereplicasets/{name:[a-z0-9][a-z0-9\-]}

Description

Get a VirtualMachineInstanceReplicaSet object.

Parameters

Type	Name	Description	Schema
Path	name required	Name of the resource	string
Path	namespace required	Object name and auth scope, such as for teams and projects	string
Query	exact optional	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.	boolean
Query	export optional	Should this value be exported. Export strips fields that a user can not specify.	boolean

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Query

exact
optional

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

boolean

Query

export
optional

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

boolean

Responses

HTTP Code	Description	Schema
200	OK	v1.VirtualMachineInstanceReplicaSet
401	Unauthorized	string

HTTP Code

Description

Schema

200

OK

401

Unauthorized

string

Produces

application/json
application/yaml
application/json;stream=watch

PUT /apis/kubevirt.io/v1alpha3/namespaces/{namespace:[a-z0-9]}/virtualmachineinstancereplicasets/{name:[a-z0-9][a-z0-9\-]}

Description

Update a VirtualMachineInstanceReplicaSet object.

Parameters

Type	Name	Description	Schema
Path	name required	Name of the resource	string
Path	namespace required	Object name and auth scope, such as for teams and projects	string
Body	body required		v1.VirtualMachineInstanceReplicaSet

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Body

body
required

Responses

HTTP Code	Description	Schema
200	OK	v1.VirtualMachineInstanceReplicaSet
201	Create	v1.VirtualMachineInstanceReplicaSet
401	Unauthorized	string

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/v1alpha3/namespaces/{namespace:[a-z0-9]}/virtualmachineinstancereplicasets/{name:[a-z0-9][a-z0-9\-]}

Description

Delete a VirtualMachineInstanceReplicaSet object.

Parameters

Type	Name	Description	Schema
Path	name required	Name of the resource	string
Path	namespace required	Object name and auth scope, such as for teams and projects	string
Query	gracePeriodSeconds optional	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 optional	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 optional	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 required		v1.DeleteOptions

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Query

gracePeriodSeconds
optional

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
optional

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
optional

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
required

Responses

HTTP Code	Description	Schema
200	OK	v1.Status
401	Unauthorized	string

HTTP Code

Description

Schema

200

OK

401

Unauthorized

string

Consumes

application/json
application/yaml

Produces

application/json
application/yaml

PATCH /apis/kubevirt.io/v1alpha3/namespaces/{namespace:[a-z0-9]}/virtualmachineinstancereplicasets/{name:[a-z0-9][a-z0-9\-]}

Description

Patch a VirtualMachineInstanceReplicaSet object.

Parameters

Type	Name	Description	Schema
Path	name required	Name of the resource	string
Path	namespace required	Object name and auth scope, such as for teams and projects	string
Body	body required		v1.Patch

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Body

body
required

Responses

HTTP Code	Description	Schema
200	OK	v1.VirtualMachineInstanceReplicaSet
401	Unauthorized	string

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/v1alpha3/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachineinstances

Description

Create a VirtualMachineInstance object.

Parameters

Type	Name	Description	Schema
Path	namespace required	Object name and auth scope, such as for teams and projects	string
Body	body required		v1.VirtualMachineInstance

Type

Name

Description

Schema

Path

namespace
required

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

string

Body

body
required

Responses

HTTP Code	Description	Schema
200	OK	v1.VirtualMachineInstance
201	Created	v1.VirtualMachineInstance
202	Accepted	v1.VirtualMachineInstance
401	Unauthorized	string

HTTP Code

Description

Schema

200

OK

201

Created

202

Accepted

v1.VirtualMachineInstanceList

401

Unauthorized

string

Consumes

application/json
application/yaml

Produces

application/json
application/yaml

GET /apis/kubevirt.io/v1alpha3/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachineinstances

Description

Get a list of VirtualMachineInstance objects.

Parameters

Type Name Description Schema

Type	Name	Description	Schema
Path	namespace required	Object name and auth scope, such as for teams and projects	string
Query	continue optional	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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 optional	A selector to restrict the list of returned objects by their fields. Defaults to everything.	string
Query	includeUninitialized optional	If true, partially initialized resources are included in the response.	boolean
Query	labelSelector optional	A selector to restrict the list of returned objects by their labels. Defaults to everything	string
Query	limit optional	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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 optional	When 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 optional	TimeoutSeconds for the list/watch call.	integer
Query	watch optional	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	boolean

Path

namespace
required

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

string

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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	v1.VirtualMachineInstanceList
401	Unauthorized	string

HTTP Code

Description

Schema

200

OK

401

Unauthorized

string

Produces

application/json
application/yaml
application/json;stream=watch

DELETE /apis/kubevirt.io/v1alpha3/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachineinstances

Description

Delete a collection of VirtualMachineInstance objects.

Parameters

Type Name Description Schema

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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/v1alpha3/namespaces/{namespace:[a-z0-9]}/virtualmachineinstances/{name:[a-z0-9][a-z0-9\-]}

Description

Get a VirtualMachineInstance object.

Parameters

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Query

exact
optional

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

boolean

Query

export
optional

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/v1alpha3/namespaces/{namespace:[a-z0-9]}/virtualmachineinstances/{name:[a-z0-9][a-z0-9\-]}

Description

Update a VirtualMachineInstance object.

Parameters

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Body

body
required

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/v1alpha3/namespaces/{namespace:[a-z0-9]}/virtualmachineinstances/{name:[a-z0-9][a-z0-9\-]}

Description

Delete a VirtualMachineInstance object.

Parameters

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Query

gracePeriodSeconds
optional

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
optional

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
optional

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
required

Responses

HTTP Code

Description

Schema

200

OK

401

Unauthorized

string

Consumes

application/json
application/yaml

Produces

application/json
application/yaml

PATCH /apis/kubevirt.io/v1alpha3/namespaces/{namespace:[a-z0-9]}/virtualmachineinstances/{name:[a-z0-9][a-z0-9\-]}

Description

Patch a VirtualMachineInstance object.

Parameters

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Body

body
required

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/v1alpha3/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachines

Description

Create a VirtualMachine object.

Parameters

Type

Name

Description

Schema

Path

namespace
required

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

string

Body

body
required

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/v1alpha3/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachines

Description

Get a list of VirtualMachine objects.

Parameters

Type Name Description Schema

Path

namespace
required

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

string

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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

v1.VirtualMachineList

401

Unauthorized

string

Produces

application/json
application/yaml
application/json;stream=watch

DELETE /apis/kubevirt.io/v1alpha3/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachines

Description

Delete a collection of VirtualMachine objects.

Parameters

Type Name Description Schema

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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/v1alpha3/namespaces/{namespace:[a-z0-9]}/virtualmachines/{name:[a-z0-9][a-z0-9\-]}

Description

Get a VirtualMachine object.

Parameters

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Query

exact
optional

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

boolean

Query

export
optional

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/v1alpha3/namespaces/{namespace:[a-z0-9]}/virtualmachines/{name:[a-z0-9][a-z0-9\-]}

Description

Update a VirtualMachine object.

Parameters

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Body

body
required

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/v1alpha3/namespaces/{namespace:[a-z0-9]}/virtualmachines/{name:[a-z0-9][a-z0-9\-]}

Description

Delete a VirtualMachine object.

Parameters

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Query

gracePeriodSeconds
optional

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
optional

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
optional

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
required

Responses

HTTP Code

Description

Schema

200

OK

401

Unauthorized

string

Consumes

application/json
application/yaml

Produces

application/json
application/yaml

PATCH /apis/kubevirt.io/v1alpha3/namespaces/{namespace:[a-z0-9]}/virtualmachines/{name:[a-z0-9][a-z0-9\-]}

Description

Patch a VirtualMachine object.

Parameters

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Body

body
required

Responses

HTTP Code

Description

Schema

200

OK

v1.VirtualMachineInstanceMigrationList

401

Unauthorized

string

Consumes

application/json-patch+json
application/merge-patch+json

Produces

application/json

GET /apis/kubevirt.io/v1alpha3/virtualmachineinstancemigrations

Description

Get a list of all VirtualMachineInstanceMigration objects.

Parameters

Type Name Description Schema

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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/v1alpha3/virtualmachineinstancepresets

Description

Get a list of all VirtualMachineInstancePreset objects.

Parameters

Type Name Description Schema

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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

v1.VirtualMachineInstancePresetList

401

Unauthorized

string

Produces

application/json
application/yaml
application/json;stream=watch

GET /apis/kubevirt.io/v1alpha3/virtualmachineinstancereplicasets

Description

Get a list of all VirtualMachineInstanceReplicaSet objects.

Parameters

Type Name Description Schema

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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

v1.VirtualMachineInstanceReplicaSetList

401

Unauthorized

string

Produces

application/json
application/yaml
application/json;stream=watch

GET /apis/kubevirt.io/v1alpha3/virtualmachineinstances

Description

Get a list of all VirtualMachineInstance objects.

Parameters

Type Name Description Schema

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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

v1.VirtualMachineInstanceList

401

Unauthorized

string

Produces

application/json
application/yaml
application/json;stream=watch

GET /apis/kubevirt.io/v1alpha3/virtualmachines

Description

Get a list of all VirtualMachine objects.

Parameters

Type Name Description Schema

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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

v1.VirtualMachineList

401

Unauthorized

string

Produces

application/json
application/yaml
application/json;stream=watch

GET /apis/kubevirt.io/v1alpha3/watch/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachineinstancemigrations

Description

Watch a VirtualMachineInstanceMigration object.

Parameters

Type Name Description Schema

Path

namespace
required

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

string

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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/v1alpha3/watch/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachineinstancepresets

Description

Watch a VirtualMachineInstancePreset object.

Parameters

Type Name Description Schema

Path

namespace
required

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

string

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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/v1alpha3/watch/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachineinstancereplicasets

Description

Watch a VirtualMachineInstanceReplicaSet object.

Parameters

Type Name Description Schema

Path

namespace
required

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

string

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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/v1alpha3/watch/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachineinstances

Description

Watch a VirtualMachineInstance object.

Parameters

Type Name Description Schema

Path

namespace
required

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

string

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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/v1alpha3/watch/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachines

Description

Watch a VirtualMachine object.

Parameters

Type Name Description Schema

Path

namespace
required

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

string

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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/v1alpha3/watch/virtualmachineinstancemigrations

Description

Watch a VirtualMachineInstanceMigrationList object.

Parameters

Type Name Description Schema

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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/v1alpha3/watch/virtualmachineinstancepresets

Description

Watch a VirtualMachineInstancePresetList object.

Parameters

Type Name Description Schema

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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/v1alpha3/watch/virtualmachineinstancereplicasets

Description

Watch a VirtualMachineInstanceReplicaSetList object.

Parameters

Type Name Description Schema

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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/v1alpha3/watch/virtualmachineinstances

Description

Watch a VirtualMachineInstanceList object.

Parameters

Type Name Description Schema

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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/v1alpha3/watch/virtualmachines

Description

Watch a VirtualMachineList object.

Parameters

Type Name Description Schema

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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

v1.APIGroup

401

Unauthorized

No Content

404

Not Found

string

Produces

application/json

GET /apis/snapshot.kubevirt.io/v1alpha1/

Description

Get KubeVirt API Resources

Responses

HTTP Code

Description

Schema

200

OK

v1.APIResourceList

401

Unauthorized

No Content

404

Not Found

string

Produces

application/json

POST /apis/snapshot.kubevirt.io/v1alpha1/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachinesnapshotcontents

Description

Create a VirtualMachineSnapshotContent object.

Parameters

Type

Name

Description

Schema

Path

namespace
required

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

string

Body

body
required

Responses

HTTP Code

Description

Schema

200

OK

201

Created

202

Accepted

v1alpha1.VirtualMachineSnapshotContentList

401

Unauthorized

string

Consumes

application/json
application/yaml

Produces

application/json
application/yaml

GET /apis/snapshot.kubevirt.io/v1alpha1/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachinesnapshotcontents

Description

Get a list of VirtualMachineSnapshotContent objects.

Parameters

Type Name Description Schema

Path

namespace
required

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

string

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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/v1alpha1/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachinesnapshotcontents

Description

Delete a collection of VirtualMachineSnapshotContent objects.

Parameters

Type Name Description Schema

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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/v1alpha1/namespaces/{namespace:[a-z0-9]}/virtualmachinesnapshotcontents/{name:[a-z0-9][a-z0-9\-]}

Description

Get a VirtualMachineSnapshotContent object.

Parameters

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Query

exact
optional

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

boolean

Query

export
optional

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/v1alpha1/namespaces/{namespace:[a-z0-9]}/virtualmachinesnapshotcontents/{name:[a-z0-9][a-z0-9\-]}

Description

Update a VirtualMachineSnapshotContent object.

Parameters

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Body

body
required

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/v1alpha1/namespaces/{namespace:[a-z0-9]}/virtualmachinesnapshotcontents/{name:[a-z0-9][a-z0-9\-]}

Description

Delete a VirtualMachineSnapshotContent object.

Parameters

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Query

gracePeriodSeconds
optional

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
optional

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
optional

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
required

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/v1alpha1/namespaces/{namespace:[a-z0-9]}/virtualmachinesnapshotcontents/{name:[a-z0-9][a-z0-9\-]}

Description

Patch a VirtualMachineSnapshotContent object.

Parameters

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Body

body
required

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/v1alpha1/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachinesnapshots

Description

Create a VirtualMachineSnapshot object.

Parameters

Type

Name

Description

Schema

Path

namespace
required

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

string

Body

body
required

Responses

HTTP Code

Description

Schema

200

OK

201

Created

202

Accepted

v1alpha1.VirtualMachineSnapshotList

401

Unauthorized

string

Consumes

application/json
application/yaml

Produces

application/json
application/yaml

GET /apis/snapshot.kubevirt.io/v1alpha1/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachinesnapshots

Description

Get a list of VirtualMachineSnapshot objects.

Parameters

Type Name Description Schema

Path

namespace
required

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

string

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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/v1alpha1/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachinesnapshots

Description

Delete a collection of VirtualMachineSnapshot objects.

Parameters

Type Name Description Schema

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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/v1alpha1/namespaces/{namespace:[a-z0-9]}/virtualmachinesnapshots/{name:[a-z0-9][a-z0-9\-]}

Description

Get a VirtualMachineSnapshot object.

Parameters

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Query

exact
optional

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

boolean

Query

export
optional

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/v1alpha1/namespaces/{namespace:[a-z0-9]}/virtualmachinesnapshots/{name:[a-z0-9][a-z0-9\-]}

Description

Update a VirtualMachineSnapshot object.

Parameters

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Body

body
required

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/v1alpha1/namespaces/{namespace:[a-z0-9]}/virtualmachinesnapshots/{name:[a-z0-9][a-z0-9\-]}

Description

Delete a VirtualMachineSnapshot object.

Parameters

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Query

gracePeriodSeconds
optional

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
optional

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
optional

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
required

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/v1alpha1/namespaces/{namespace:[a-z0-9]}/virtualmachinesnapshots/{name:[a-z0-9][a-z0-9\-]}

Description

Patch a VirtualMachineSnapshot object.

Parameters

Type

Name

Description

Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Body

body
required

Responses

HTTP Code

Description

Schema

200

OK

v1alpha1.VirtualMachineSnapshotContentList

401

Unauthorized

string

Consumes

application/json-patch+json
application/merge-patch+json

Produces

application/json

GET /apis/snapshot.kubevirt.io/v1alpha1/virtualmachinesnapshotcontents

Description

Get a list of all VirtualMachineSnapshotContent objects.

Parameters

Type Name Description Schema

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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/v1alpha1/virtualmachinesnapshots

Description

Get a list of all VirtualMachineSnapshot objects.

Parameters

Type Name Description Schema

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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

v1alpha1.VirtualMachineSnapshotList

401

Unauthorized

string

Produces

application/json
application/yaml
application/json;stream=watch

GET /apis/snapshot.kubevirt.io/v1alpha1/watch/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachinesnapshotcontents

Description

Watch a VirtualMachineSnapshotContent object.

Parameters

Type Name Description Schema

Path

namespace
required

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

string

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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/v1alpha1/watch/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachinesnapshots

Description

Watch a VirtualMachineSnapshot object.

Parameters

Type Name Description Schema

Path

namespace
required

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

string

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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/v1alpha1/watch/virtualmachinesnapshotcontents

Description

Watch a VirtualMachineSnapshotContentList object.

Parameters

Type Name Description Schema

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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/v1alpha1/watch/virtualmachinesnapshots

Description

Watch a VirtualMachineSnapshotList object.

Parameters

Type Name Description Schema

Query

continue
optional

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not 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
optional

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string

Query

includeUninitialized
optional

If true, partially initialized resources are included in the response.

boolean

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything

string

Query

limit
optional

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
optional

When 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
optional

TimeoutSeconds for the list/watch call.

integer

Query

watch
optional

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