Operations

Get a KubeVirt API group

GET /apis/kubevirt.io

Responses

HTTP Code Description Schema

200

OK

v1.APIGroup

404

Not Found

No Content

default

OK

v1.APIGroup

Produces

  • application/json

Get KubeVirt API Resources

GET /apis/kubevirt.io/v1alpha1

Responses

HTTP Code Description Schema

200

OK

v1.APIResourceList

404

Not Found

No Content

default

OK

v1.APIResourceList

Produces

  • application/json

Health endpoint

GET /apis/kubevirt.io/v1alpha1/healthz

Responses

HTTP Code Description Schema

200

OK

No Content

500

Unhealthy

No Content

default

OK

No Content

Consumes

  • application/json

Produces

  • application/json

Create a VirtualMachine object.

POST /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinepresets

Parameters

Type Name Description Schema

Path

namespace
required

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

string

Body

body
required

v1.VirtualMachinePreset

Responses

HTTP Code Description Schema

200

OK

v1.VirtualMachinePreset

201

Created

v1.VirtualMachinePreset

202

Accepted

v1.VirtualMachinePreset

401

Unauthorized

No Content

default

OK

v1.VirtualMachinePreset

Consumes

  • application/json

  • application/yaml

Produces

  • application/json

  • application/yaml

Get a list of VirtualMachine objects.

GET /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinepresets

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.VirtualMachinePresetList

401

Unauthorized

No Content

default

OK

v1.VirtualMachinePresetList

Produces

  • application/json

  • application/yaml

  • application/json;stream=watch

Delete a collection of VirtualMachine objects.

DELETE /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinepresets

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.Status

401

Unauthorized

No Content

default

OK

v1.Status

Produces

  • application/json

  • application/yaml

Get a VirtualMachine object.

GET /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinepresets/{name}

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

v1.VirtualMachinePreset

401

Unauthorized

No Content

default

OK

v1.VirtualMachinePreset

Produces

  • application/json

  • application/yaml

  • application/json;stream=watch

Update a VirtualMachine object.

PUT /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinepresets/{name}

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.VirtualMachinePreset

Responses

HTTP Code Description Schema

200

OK

v1.VirtualMachinePreset

201

Create

v1.VirtualMachinePreset

401

Unauthorized

No Content

default

OK

v1.VirtualMachinePreset

Consumes

  • application/json

  • application/yaml

Produces

  • application/json

  • application/yaml

Delete a VirtualMachine object.

DELETE /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinepresets/{name}

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

Responses

HTTP Code Description Schema

200

OK

v1.Status

401

Unauthorized

No Content

default

OK

v1.Status

Consumes

  • application/json

  • application/yaml

Produces

  • application/json

  • application/yaml

Patch a VirtualMachine object.

PATCH /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinepresets/{name}

Parameters

Type Name Schema

Body

body
required

v1.Patch

Responses

HTTP Code Description Schema

200

OK

v1.VirtualMachinePreset

401

Unauthorized

No Content

default

OK

v1.VirtualMachinePreset

Consumes

  • application/json-patch+json

  • application/merge-patch+json

Produces

  • application/json

Create a VirtualMachineReplicaSet object.

POST /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinereplicasets

Parameters

Type Name Description Schema

Path

namespace
required

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

string

Body

body
required

v1.VirtualMachineReplicaSet

Responses

HTTP Code Description Schema

200

OK

v1.VirtualMachineReplicaSet

201

Created

v1.VirtualMachineReplicaSet

202

Accepted

v1.VirtualMachineReplicaSet

401

Unauthorized

No Content

default

OK

v1.VirtualMachineReplicaSet

Consumes

  • application/json

  • application/yaml

Produces

  • application/json

  • application/yaml

Get a list of VirtualMachineReplicaSet objects.

GET /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinereplicasets

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.VirtualMachineReplicaSetList

401

Unauthorized

No Content

default

OK

v1.VirtualMachineReplicaSetList

Produces

  • application/json

  • application/yaml

  • application/json;stream=watch

Delete a collection of VirtualMachineReplicaSet objects.

DELETE /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinereplicasets

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.Status

401

Unauthorized

No Content

default

OK

v1.Status

Produces

  • application/json

  • application/yaml

Get a VirtualMachineReplicaSet object.

GET /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinereplicasets/{name}

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

v1.VirtualMachineReplicaSet

401

Unauthorized

No Content

default

OK

v1.VirtualMachineReplicaSet

Produces

  • application/json

  • application/yaml

  • application/json;stream=watch

Update a VirtualMachineReplicaSet object.

PUT /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinereplicasets/{name}

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.VirtualMachineReplicaSet

Responses

HTTP Code Description Schema

200

OK

v1.VirtualMachineReplicaSet

201

Create

v1.VirtualMachineReplicaSet

401

Unauthorized

No Content

default

OK

v1.VirtualMachineReplicaSet

Consumes

  • application/json

  • application/yaml

Produces

  • application/json

  • application/yaml

Delete a VirtualMachineReplicaSet object.

DELETE /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinereplicasets/{name}

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

Responses

HTTP Code Description Schema

200

OK

v1.Status

401

Unauthorized

No Content

default

OK

v1.Status

Consumes

  • application/json

  • application/yaml

Produces

  • application/json

  • application/yaml

Patch a VirtualMachineReplicaSet object.

PATCH /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinereplicasets/{name}

Parameters

Type Name Schema

Body

body
required

v1.Patch

Responses

HTTP Code Description Schema

200

OK

v1.VirtualMachineReplicaSet

401

Unauthorized

No Content

default

OK

v1.VirtualMachineReplicaSet

Consumes

  • application/json-patch+json

  • application/merge-patch+json

Produces

  • application/json

Create a VirtualMachine object.

POST /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachines

Parameters

Type Name Description Schema

Path

namespace
required

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

string

Body

body
required

v1.VirtualMachine

Responses

HTTP Code Description Schema

200

OK

v1.VirtualMachine

201

Created

v1.VirtualMachine

202

Accepted

v1.VirtualMachine

401

Unauthorized

No Content

default

OK

v1.VirtualMachine

Consumes

  • application/json

  • application/yaml

Produces

  • application/json

  • application/yaml

Get a list of VirtualMachine objects.

GET /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachines

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

No Content

default

OK

v1.VirtualMachineList

Produces

  • application/json

  • application/yaml

  • application/json;stream=watch

Delete a collection of VirtualMachine objects.

DELETE /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachines

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.Status

401

Unauthorized

No Content

default

OK

v1.Status

Produces

  • application/json

  • application/yaml

Get a VirtualMachine object.

GET /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachines/{name}

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

v1.VirtualMachine

401

Unauthorized

No Content

default

OK

v1.VirtualMachine

Produces

  • application/json

  • application/yaml

  • application/json;stream=watch

Update a VirtualMachine object.

PUT /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachines/{name}

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.VirtualMachine

Responses

HTTP Code Description Schema

200

OK

v1.VirtualMachine

201

Create

v1.VirtualMachine

401

Unauthorized

No Content

default

OK

v1.VirtualMachine

Consumes

  • application/json

  • application/yaml

Produces

  • application/json

  • application/yaml

Delete a VirtualMachine object.

DELETE /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachines/{name}

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

Responses

HTTP Code Description Schema

200

OK

v1.Status

401

Unauthorized

No Content

default

OK

v1.Status

Consumes

  • application/json

  • application/yaml

Produces

  • application/json

  • application/yaml

Patch a VirtualMachine object.

PATCH /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachines/{name}

Parameters

Type Name Schema

Body

body
required

v1.Patch

Responses

HTTP Code Description Schema

200

OK

v1.VirtualMachine

401

Unauthorized

No Content

default

OK

v1.VirtualMachine

Consumes

  • application/json-patch+json

  • application/merge-patch+json

Produces

  • application/json

Get a list of all VirtualMachine objects.

GET /apis/kubevirt.io/v1alpha1/virtualmachinepresets

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.VirtualMachinePresetList

401

Unauthorized

No Content

default

OK

v1.VirtualMachinePresetList

Produces

  • application/json

  • application/yaml

  • application/json;stream=watch

Get a list of all VirtualMachineReplicaSet objects.

GET /apis/kubevirt.io/v1alpha1/virtualmachinereplicasets

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.VirtualMachineReplicaSetList

401

Unauthorized

No Content

default

OK

v1.VirtualMachineReplicaSetList

Produces

  • application/json

  • application/yaml

  • application/json;stream=watch

Get a list of all VirtualMachine objects.

GET /apis/kubevirt.io/v1alpha1/virtualmachines

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

No Content

default

OK

v1.VirtualMachineList

Produces

  • application/json

  • application/yaml

  • application/json;stream=watch

Watch a VirtualMachine object.

GET /apis/kubevirt.io/v1alpha1/watch/namespaces/{namespace}/virtualmachinepresets

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.WatchEvent

401

Unauthorized

No Content

default

OK

v1.WatchEvent

Produces

  • application/json

Watch a VirtualMachineReplicaSet object.

GET /apis/kubevirt.io/v1alpha1/watch/namespaces/{namespace}/virtualmachinereplicasets

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.WatchEvent

401

Unauthorized

No Content

default

OK

v1.WatchEvent

Produces

  • application/json

Watch a VirtualMachine object.

GET /apis/kubevirt.io/v1alpha1/watch/namespaces/{namespace}/virtualmachines

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.WatchEvent

401

Unauthorized

No Content

default

OK

v1.WatchEvent

Produces

  • application/json

Watch a VirtualMachineList object.

GET /apis/kubevirt.io/v1alpha1/watch/virtualmachinepresets

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.WatchEvent

401

Unauthorized

No Content

default

OK

v1.WatchEvent

Produces

  • application/json

Watch a VirtualMachineReplicaSetList object.

GET /apis/kubevirt.io/v1alpha1/watch/virtualmachinereplicasets

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.WatchEvent

401

Unauthorized

No Content

default

OK

v1.WatchEvent

Produces

  • application/json

Watch a VirtualMachineList object.

GET /apis/kubevirt.io/v1alpha1/watch/virtualmachines

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.WatchEvent

401

Unauthorized

No Content

default

OK

v1.WatchEvent

Produces

  • application/json