Operations

GET /

Description

Get KubeVirt API root paths

Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

404

Not Found

string

Produces

  • application/json

GET /apis

Description

Get a KubeVirt API GroupList

Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

404

Not Found

string

Produces

  • application/json

GET /apis/flavor.kubevirt.io/

Description

Get a KubeVirt API group

Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

404

Not Found

string

Produces

  • application/json

GET /apis/flavor.kubevirt.io/v1alpha1/

Description

Get KubeVirt API Resources

Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

404

Not Found

string

Produces

  • application/json

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

Description

Create a VirtualMachineFlavor 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/flavor.kubevirt.io/v1alpha1/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachineflavors

Description

Get a list of VirtualMachineFlavor 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/flavor.kubevirt.io/v1alpha1/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachineflavors

Description

Delete a collection of VirtualMachineFlavor 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/flavor.kubevirt.io/v1alpha1/namespaces/{namespace:[a-z0-9]}/virtualmachineflavors/{name:[a-z0-9][a-z0-9\-]}

Description

Get a VirtualMachineFlavor 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/flavor.kubevirt.io/v1alpha1/namespaces/{namespace:[a-z0-9]}/virtualmachineflavors/{name:[a-z0-9][a-z0-9\-]}

Description

Update a VirtualMachineFlavor 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/flavor.kubevirt.io/v1alpha1/namespaces/{namespace:[a-z0-9]}/virtualmachineflavors/{name:[a-z0-9][a-z0-9\-]}

Description

Delete a VirtualMachineFlavor 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/flavor.kubevirt.io/v1alpha1/namespaces/{namespace:[a-z0-9]}/virtualmachineflavors/{name:[a-z0-9][a-z0-9\-]}

Description

Patch a VirtualMachineFlavor 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/flavor.kubevirt.io/v1alpha1/virtualmachineclusterflavors

Description

Create a VirtualMachineClusterFlavor object.

Parameters

Type Name Schema

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/flavor.kubevirt.io/v1alpha1/virtualmachineclusterflavors

Description

Get a list of VirtualMachineClusterFlavor 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

DELETE /apis/flavor.kubevirt.io/v1alpha1/virtualmachineclusterflavors

Description

Delete a collection of VirtualMachineClusterFlavor 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/flavor.kubevirt.io/v1alpha1/virtualmachineclusterflavors/{name:[a-z0-9][a-z0-9\-]*}

Description

Get a VirtualMachineClusterFlavor object.

Parameters

Type Name Description Schema

Path

name
required

Name of the resource

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/flavor.kubevirt.io/v1alpha1/virtualmachineclusterflavors/{name:[a-z0-9][a-z0-9\-]*}

Description

Update a VirtualMachineClusterFlavor object.

Parameters

Type Name Description Schema

Path

name
required

Name of the resource

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/flavor.kubevirt.io/v1alpha1/virtualmachineclusterflavors/{name:[a-z0-9][a-z0-9\-]*}

Description

Delete a VirtualMachineClusterFlavor object.

Parameters

Type Name Description Schema

Path

name
required

Name of the resource

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/flavor.kubevirt.io/v1alpha1/virtualmachineclusterflavors/{name:[a-z0-9][a-z0-9\-]*}

Description

Patch a VirtualMachineClusterFlavor object.

Parameters

Type Name Description Schema

Path

name
required

Name of the resource

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

GET /apis/flavor.kubevirt.io/v1alpha1/virtualmachineflavors

Description

Get a list of all VirtualMachineFlavor 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/flavor.kubevirt.io/v1alpha1/watch/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachineflavors

Description

Watch a VirtualMachineFlavor 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/flavor.kubevirt.io/v1alpha1/watch/virtualmachineclusterflavors

Description

Watch a VirtualMachineClusterFlavorList 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/flavor.kubevirt.io/v1alpha1/watch/virtualmachineflavors

Description

Watch a VirtualMachineFlavorList 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/

Description

Get a KubeVirt API group

Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

404

Not Found

string

Produces

  • application/json

GET /apis/kubevirt.io/v1/

Description

Get KubeVirt API Resources

Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

404

Not Found

string

Produces

  • application/json

GET /apis/kubevirt.io/v1/kubevirt

Description

Get a list of all KubeVirt objects.

Parameters

Type Name Description Schema

Query

continue
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

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

Description

Create a KubeVirt 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/v1/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/kubevirt

Description

Get a list of KubeVirt 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/kubevirt.io/v1/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/kubevirt

Description

Delete a collection of KubeVirt 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/v1/namespaces/{namespace:[a-z0-9]}/kubevirt/{name:[a-z0-9][a-z0-9\-]}

Description

Get a KubeVirt 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/v1/namespaces/{namespace:[a-z0-9]}/kubevirt/{name:[a-z0-9][a-z0-9\-]}

Description

Update a KubeVirt 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/v1/namespaces/{namespace:[a-z0-9]}/kubevirt/{name:[a-z0-9][a-z0-9\-]}

Description

Delete a KubeVirt 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/v1/namespaces/{namespace:[a-z0-9]}/kubevirt/{name:[a-z0-9][a-z0-9\-]}

Description

Patch a KubeVirt 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/v1/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachineinstancemigrations

Description

Create a VirtualMachineInstanceMigration 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/v1/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachineinstancemigrations

Description

Get a list of VirtualMachineInstanceMigration 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/kubevirt.io/v1/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachineinstancemigrations

Description

Delete a collection of 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

GET /apis/kubevirt.io/v1/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

Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

string

Produces

  • application/json

  • application/yaml

  • application/json;stream=watch

PUT /apis/kubevirt.io/v1/namespaces/{namespace:[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

Responses

HTTP Code Description Schema

200

OK

201

Create

401

Unauthorized

string

Consumes

  • application/json

  • application/yaml

Produces

  • application/json

  • application/yaml

DELETE /apis/kubevirt.io/v1/namespaces/{namespace:[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

Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

string

Consumes

  • application/json

  • application/yaml

Produces

  • application/json

  • application/yaml

PATCH /apis/kubevirt.io/v1/namespaces/{namespace:[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

Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

string

Consumes

  • application/json-patch+json

  • application/merge-patch+json

Produces

  • application/json

POST /apis/kubevirt.io/v1/namespaces/{namespace:[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

Responses

HTTP Code Description Schema

200

OK

201

Created

202

Accepted

401

Unauthorized

string

Consumes

  • application/json

  • application/yaml

Produces

  • application/json

  • application/yaml

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

Description

Get a list of VirtualMachineInstancePreset 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/kubevirt.io/v1/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachineinstancepresets

Description

Delete a collection of 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

401

Unauthorized

string

Produces

  • application/json

  • application/yaml

GET /apis/kubevirt.io/v1/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

Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

string

Produces

  • application/json

  • application/yaml

  • application/json;stream=watch

PUT /apis/kubevirt.io/v1/namespaces/{namespace:[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

Responses

HTTP Code Description Schema

200

OK

201

Create

401

Unauthorized

string

Consumes

  • application/json

  • application/yaml

Produces

  • application/json

  • application/yaml

DELETE /apis/kubevirt.io/v1/namespaces/{namespace:[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

Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

string

Consumes

  • application/json

  • application/yaml

Produces

  • application/json

  • application/yaml

PATCH /apis/kubevirt.io/v1/namespaces/{namespace:[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

Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

string

Consumes

  • application/json-patch+json

  • application/merge-patch+json

Produces

  • application/json

POST /apis/kubevirt.io/v1/namespaces/{namespace:[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

Responses

HTTP Code Description Schema

200

OK

201

Created

202

Accepted

401

Unauthorized

string

Consumes

  • application/json

  • application/yaml

Produces

  • application/json

  • application/yaml

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

Description

Get a list of VirtualMachineInstanceReplicaSet 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/kubevirt.io/v1/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachineinstancereplicasets

Description

Delete a collection of 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

401

Unauthorized

string

Produces

  • application/json

  • application/yaml

GET /apis/kubevirt.io/v1/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

Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

string

Produces

  • application/json

  • application/yaml

  • application/json;stream=watch

PUT /apis/kubevirt.io/v1/namespaces/{namespace:[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

Responses

HTTP Code Description Schema

200

OK

201

Create

401

Unauthorized

string

Consumes

  • application/json

  • application/yaml

Produces

  • application/json

  • application/yaml

DELETE /apis/kubevirt.io/v1/namespaces/{namespace:[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

Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

string

Consumes

  • application/json

  • application/yaml

Produces

  • application/json

  • application/yaml

PATCH /apis/kubevirt.io/v1/namespaces/{namespace:[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

Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

string

Consumes

  • application/json-patch+json

  • application/merge-patch+json

Produces

  • application/json

POST /apis/kubevirt.io/v1/namespaces/{namespace:[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

Responses

HTTP Code Description Schema

200

OK

201

Created

202

Accepted

401

Unauthorized

string

Consumes

  • application/json

  • application/yaml

Produces

  • application/json

  • application/yaml

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

Description

Get a list of VirtualMachineInstance 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/kubevirt.io/v1/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/v1/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/v1/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/v1/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/v1/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/v1/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/v1/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

401

Unauthorized

string

Produces

  • application/json

  • application/yaml

  • application/json;stream=watch

DELETE /apis/kubevirt.io/v1/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/v1/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/v1/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/v1/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/v1/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

401

Unauthorized

string

Consumes

  • application/json-patch+json

  • application/merge-patch+json

Produces

  • application/json

GET /apis/kubevirt.io/v1/virtualmachineinstancemigrations

Description

Get a list of all VirtualMachineInstanceMigration objects.

Parameters

Type Name Description Schema

Query

continue
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/v1/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

401

Unauthorized

string

Produces

  • application/json

  • application/yaml

  • application/json;stream=watch

GET /apis/kubevirt.io/v1/virtualmachineinstancereplicasets

Description

Get a list of all VirtualMachineInstanceReplicaSet objects.

Parameters

Type Name Description Schema

Query

continue
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/v1/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

401

Unauthorized

string

Produces

  • application/json

  • application/yaml

  • application/json;stream=watch

GET /apis/kubevirt.io/v1/virtualmachines

Description

Get a list of all VirtualMachine objects.

Parameters

Type Name Description Schema

Query

continue
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/v1/watch/kubevirt

Description

Watch a KubeVirtList 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/v1/watch/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/kubevirt

Description

Watch a KubeVirt 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/v1/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/v1/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/v1/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/v1/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/v1/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/v1/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/v1/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/v1/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/v1/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/v1/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

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

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\-]*}/virtualmachinerestores

Description

Create a VirtualMachineRestore 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/snapshot.kubevirt.io/v1alpha1/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachinerestores

Description

Get a list of VirtualMachineRestore 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\-]*}/virtualmachinerestores

Description

Delete a collection of VirtualMachineRestore 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]}/virtualmachinerestores/{name:[a-z0-9][a-z0-9\-]}

Description

Get a VirtualMachineRestore 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]}/virtualmachinerestores/{name:[a-z0-9][a-z0-9\-]}

Description

Update a VirtualMachineRestore 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]}/virtualmachinerestores/{name:[a-z0-9][a-z0-9\-]}

Description

Delete a VirtualMachineRestore 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]}/virtualmachinerestores/{name:[a-z0-9][a-z0-9\-]}

Description

Patch a VirtualMachineRestore 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\-]*}/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

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

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

401

Unauthorized

string

Consumes

  • application/json-patch+json

  • application/merge-patch+json

Produces

  • application/json

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

Description

Get a list of all VirtualMachineRestore 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/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

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\-]*}/virtualmachinerestores

Description

Watch a VirtualMachineRestore 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\-]*}/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/virtualmachinerestores

Description

Watch a VirtualMachineRestoreList 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/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

401

Unauthorized

string

Produces

  • application/json

GET /apis/subresources.kubevirt.io

Description

Get a KubeVirt API Group

Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

404

Not Found

string

Produces

  • application/json

GET /apis/subresources.kubevirt.io/v1/

Description

Get a KubeVirt API resources

Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

404

Not Found

string

Produces

  • application/json

GET /apis/subresources.kubevirt.io/v1/dump-cluster-profiler

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

Produces

  • application/json

GET /apis/subresources.kubevirt.io/v1/guestfs

Responses

HTTP Code Description Schema

200

OK

string

400

Bad Request

string

401

Unauthorized

No Content

Produces

  • application/json

GET /apis/subresources.kubevirt.io/v1/healthz

Description

Health endpoint

Responses

HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

500

Unhealthy

string

Consumes

  • application/json

Produces

  • application/json

PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace:[a-z0-9]}/virtualmachineinstances/{name:[a-z0-9][a-z0-9\-]}/addvolume

Description

Add a volume and disk to a running Virtual Machine Instance

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

string

400

Bad Request

string

401

Unauthorized

No Content

GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace:[a-z0-9]}/virtualmachineinstances/{name:[a-z0-9][a-z0-9\-]}/console

Description

Open a websocket connection to a serial console on the specified VirtualMachineInstance.

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

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace:[a-z0-9]}/virtualmachineinstances/{name:[a-z0-9][a-z0-9\-]}/filesystemlist

Description

Get list of active filesystems on guest machine via guest agent

Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

Consumes

  • application/json

Produces

  • application/json

PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace:[a-z0-9]}/virtualmachineinstances/{name:[a-z0-9][a-z0-9\-]}/freeze

Description

Freeze 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

string

401

Unauthorized

No Content

500

Internal Server Error

string

GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace:[a-z0-9]}/virtualmachineinstances/{name:[a-z0-9][a-z0-9\-]}/guestosinfo

Description

Get guest agent os information

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

Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

Consumes

  • application/json

Produces

  • application/json

PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace:[a-z0-9]}/virtualmachineinstances/{name:[a-z0-9][a-z0-9\-]}/pause

Description

Pause 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

string

400

Bad Request

string

401

Unauthorized

No Content

404

Not Found

string

GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace:[a-z0-9]}/virtualmachineinstances/{name:[a-z0-9][a-z0-9\-]}/portforward/{port:[0-9]+}

Description

Open a websocket connection forwarding traffic to the specified VirtualMachineInstance and port.

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

Path

port
required

The target port for portforward on the VirtualMachineInstance.

string

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace:[a-z0-9]}/virtualmachineinstances/{name:[a-z0-9][a-z0-9\-]}/portforward/{port:[0-9]+}/{protocol:tcp|udp}

Description

Open a websocket connection forwarding traffic of the specified protocol (either tcp or udp) to the specified VirtualMachineInstance and port.

Parameters

Type Name Description Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Path

port
required

The target port for portforward on the VirtualMachineInstance.

string

Path

protocol
required

The protocol for portforward on the VirtualMachineInstance.

string

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace:[a-z0-9]}/virtualmachineinstances/{name:[a-z0-9][a-z0-9\-]}/removevolume

Description

Removes a volume and disk from a running Virtual Machine Instance

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

string

400

Bad Request

string

401

Unauthorized

No Content

PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace:[a-z0-9]}/virtualmachineinstances/{name:[a-z0-9][a-z0-9\-]}/softreboot

Description

Soft reboot 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

Responses

HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

500

Internal Server Error

string

GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace:[a-z0-9]}/virtualmachineinstances/{name:[a-z0-9][a-z0-9\-]}/test

Description

Test endpoint verifying apiserver connectivity.

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

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace:[a-z0-9]}/virtualmachineinstances/{name:[a-z0-9][a-z0-9\-]}/unfreeze

Description

Unfreeze 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

Responses

HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

500

Internal Server Error

string

PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace:[a-z0-9]}/virtualmachineinstances/{name:[a-z0-9][a-z0-9\-]}/unpause

Description

Unpause 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

string

400

Bad Request

string

401

Unauthorized

No Content

404

Not Found

string

GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace:[a-z0-9]}/virtualmachineinstances/{name:[a-z0-9][a-z0-9\-]}/usbredir

Description

Open a websocket connection to connect to USB device on the specified VirtualMachineInstance.

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

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace:[a-z0-9]}/virtualmachineinstances/{name:[a-z0-9][a-z0-9\-]}/userlist

Description

Get list of active users via guest agent

Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

Consumes

  • application/json

Produces

  • application/json

GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace:[a-z0-9]}/virtualmachineinstances/{name:[a-z0-9][a-z0-9\-]}/vnc

Description

Open a websocket connection to connect to VNC on the specified VirtualMachineInstance.

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

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace:[a-z0-9]}/virtualmachines/{name:[a-z0-9][a-z0-9\-]}/addvolume

Description

Add a volume and disk to a running Virtual Machine.

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

string

400

Bad Request

string

401

Unauthorized

No Content

PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace:[a-z0-9]}/virtualmachines/{name:[a-z0-9][a-z0-9\-]}/migrate

Description

Migrate a running VirtualMachine to another node.

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

Responses

HTTP Code Description Schema

200

OK

string

400

Bad Request

string

401

Unauthorized

No Content

404

Not Found

string

GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace:[a-z0-9]}/virtualmachines/{name:[a-z0-9][a-z0-9\-]}/portforward/{port:[0-9]+}

Description

Open a websocket connection forwarding traffic to the running VMI for the specified VirtualMachine and port.

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

Path

port
required

The target port for portforward on the VirtualMachineInstance.

string

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

GET /apis/subresources.kubevirt.io/v1/namespaces/{namespace:[a-z0-9]}/virtualmachines/{name:[a-z0-9][a-z0-9\-]}/portforward/{port:[0-9]+}/{protocol:tcp|udp}

Description

Open a websocket connection forwarding traffic of the specified protocol (either tcp or udp) to the specified VirtualMachine and port.

Parameters

Type Name Description Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Path

port
required

The target port for portforward on the VirtualMachineInstance.

string

Path

protocol
required

The protocol for portforward on the VirtualMachineInstance.

string

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace:[a-z0-9]}/virtualmachines/{name:[a-z0-9][a-z0-9\-]}/removevolume

Description

Removes a volume and disk from a running Virtual Machine.

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

string

400

Bad Request

string

401

Unauthorized

No Content

PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace:[a-z0-9]}/virtualmachines/{name:[a-z0-9][a-z0-9\-]}/restart

Description

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

Responses

HTTP Code Description Schema

200

OK

string

400

Bad Request

string

401

Unauthorized

No Content

404

Not Found

string

PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace:[a-z0-9]}/virtualmachines/{name:[a-z0-9][a-z0-9\-]}/start

Description

Start 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

string

400

Bad Request

string

401

Unauthorized

No Content

404

Not Found

string

PUT /apis/subresources.kubevirt.io/v1/namespaces/{namespace:[a-z0-9]}/virtualmachines/{name:[a-z0-9][a-z0-9\-]}/stop

Description

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

Responses

HTTP Code Description Schema

200

OK

string

400

Bad Request

string

401

Unauthorized

No Content

404

Not Found

string

GET /apis/subresources.kubevirt.io/v1/start-cluster-profiler

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

Produces

  • application/json

GET /apis/subresources.kubevirt.io/v1/stop-cluster-profiler

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

Produces

  • application/json

GET /apis/subresources.kubevirt.io/v1/version

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

Produces

  • application/json

GET /apis/subresources.kubevirt.io/v1alpha3/

Description

Get a KubeVirt API resources

Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

404

Not Found

string

Produces

  • application/json

GET /apis/subresources.kubevirt.io/v1alpha3/dump-cluster-profiler

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

Produces

  • application/json

GET /apis/subresources.kubevirt.io/v1alpha3/guestfs

Responses

HTTP Code Description Schema

200

OK

string

400

Bad Request

string

401

Unauthorized

No Content

Produces

  • application/json

GET /apis/subresources.kubevirt.io/v1alpha3/healthz

Description

Health endpoint

Responses

HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

500

Unhealthy

string

Consumes

  • application/json

Produces

  • application/json

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

Description

Add a volume and disk to a running Virtual Machine Instance

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

string

400

Bad Request

string

401

Unauthorized

No Content

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

Description

Open a websocket connection to a serial console on the specified VirtualMachineInstance.

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

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

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

Description

Get list of active filesystems on guest machine via guest agent

Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

Consumes

  • application/json

Produces

  • application/json

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

Description

Freeze 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

string

401

Unauthorized

No Content

500

Internal Server Error

string

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

Description

Get guest agent os information

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

Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

Consumes

  • application/json

Produces

  • application/json

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

Description

Pause 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

string

400

Bad Request

string

401

Unauthorized

No Content

404

Not Found

string

GET /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace:[a-z0-9]}/virtualmachineinstances/{name:[a-z0-9][a-z0-9\-]}/portforward/{port:[0-9]+}

Description

Open a websocket connection forwarding traffic to the specified VirtualMachineInstance and port.

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

Path

port
required

The target port for portforward on the VirtualMachineInstance.

string

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

GET /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace:[a-z0-9]}/virtualmachineinstances/{name:[a-z0-9][a-z0-9\-]}/portforward/{port:[0-9]+}/{protocol:tcp|udp}

Description

Open a websocket connection forwarding traffic of the specified protocol (either tcp or udp) to the specified VirtualMachineInstance and port.

Parameters

Type Name Description Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Path

port
required

The target port for portforward on the VirtualMachineInstance.

string

Path

protocol
required

The protocol for portforward on the VirtualMachineInstance.

string

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

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

Description

Removes a volume and disk from a running Virtual Machine Instance

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

string

400

Bad Request

string

401

Unauthorized

No Content

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

Description

Soft reboot 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

Responses

HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

500

Internal Server Error

string

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

Description

Test endpoint verifying apiserver connectivity.

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

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

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

Description

Unfreeze 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

Responses

HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

500

Internal Server Error

string

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

Description

Unpause 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

string

400

Bad Request

string

401

Unauthorized

No Content

404

Not Found

string

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

Description

Open a websocket connection to connect to USB device on the specified VirtualMachineInstance.

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

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

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

Description

Get list of active users via guest agent

Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

Consumes

  • application/json

Produces

  • application/json

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

Description

Open a websocket connection to connect to VNC on the specified VirtualMachineInstance.

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

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

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

Description

Add a volume and disk to a running Virtual Machine.

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

string

400

Bad Request

string

401

Unauthorized

No Content

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

Description

Migrate a running VirtualMachine to another node.

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

Responses

HTTP Code Description Schema

200

OK

string

400

Bad Request

string

401

Unauthorized

No Content

404

Not Found

string

GET /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace:[a-z0-9]}/virtualmachines/{name:[a-z0-9][a-z0-9\-]}/portforward/{port:[0-9]+}

Description

Open a websocket connection forwarding traffic to the running VMI for the specified VirtualMachine and port.

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

Path

port
required

The target port for portforward on the VirtualMachineInstance.

string

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

GET /apis/subresources.kubevirt.io/v1alpha3/namespaces/{namespace:[a-z0-9]}/virtualmachines/{name:[a-z0-9][a-z0-9\-]}/portforward/{port:[0-9]+}/{protocol:tcp|udp}

Description

Open a websocket connection forwarding traffic of the specified protocol (either tcp or udp) to the specified VirtualMachine and port.

Parameters

Type Name Description Schema

Path

name
required

Name of the resource

string

Path

namespace
required

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

string

Path

port
required

The target port for portforward on the VirtualMachineInstance.

string

Path

protocol
required

The protocol for portforward on the VirtualMachineInstance.

string

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

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

Description

Removes a volume and disk from a running Virtual Machine.

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

string

400

Bad Request

string

401

Unauthorized

No Content

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

Description

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

Responses

HTTP Code Description Schema

200

OK

string

400

Bad Request

string

401

Unauthorized

No Content

404

Not Found

string

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

Description

Start 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

string

400

Bad Request

string

401

Unauthorized

No Content

404

Not Found

string

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

Description

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

Responses

HTTP Code Description Schema

200

OK

string

400

Bad Request

string

401

Unauthorized

No Content

404

Not Found

string

GET /apis/subresources.kubevirt.io/v1alpha3/start-cluster-profiler

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

Produces

  • application/json

GET /apis/subresources.kubevirt.io/v1alpha3/stop-cluster-profiler

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

Produces

  • application/json

GET /apis/subresources.kubevirt.io/v1alpha3/version

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

Produces

  • application/json

GET /dump-profiler

Description

dump profiler results endpoint

Responses

HTTP Code Description Schema

401

Unauthorized

No Content

GET /healthz

Description

Health endpoint

Responses

HTTP Code Description Schema

401

Unauthorized

No Content