Operations
Get a KubeVirt API group
GET /apis/kubevirt.io
Description
Get a KubeVirt API group
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
default |
OK |
Produces
-
application/json
Get KubeVirt API Resources
GET /apis/kubevirt.io/v1alpha1
Description
Get KubeVirt API Resources
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
default |
OK |
Produces
-
application/json
Health endpoint
GET /apis/kubevirt.io/v1alpha1/healthz
Description
Health endpoint
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
No Content |
500 |
Unhealthy |
No Content |
default |
OK |
No Content |
Consumes
-
application/json
Produces
-
application/json
Get a list of all Migration objects.
GET /apis/kubevirt.io/v1alpha1/migrations
Description
Get a list of all Migration objects.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
Create a Migration object.
POST /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/migrations
Description
Create a Migration object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Created |
|
404 |
Not Found |
No Content |
Consumes
-
application/json
-
application/yaml
Produces
-
application/json
-
application/yaml
Get a list of Migration objects.
GET /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/migrations
Description
Get a list of Migration objects.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace' |
boolean |
Query |
export |
Should this value be exported. Export strips fields that a user can not specify. |
boolean |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
Delete a collection of Migration objects.
DELETE /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/migrations
Description
Delete a collection of Migration objects.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Deleted |
|
404 |
Not Found |
No Content |
default |
Deleted |
Produces
-
application/json
-
application/yaml
Get a Migration object.
GET /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/migrations/{name}
Description
Get a Migration object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace' |
boolean |
Query |
export |
Should this value be exported. Export strips fields that a user can not specify. |
boolean |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
Update a Migration object.
PUT /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/migrations/{name}
Description
Update a Migration object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Replaced |
|
404 |
Not Found |
No Content |
default |
Replaced |
Consumes
-
application/json
-
application/yaml
Produces
-
application/json
-
application/yaml
Delete a Migration object.
DELETE /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/migrations/{name}
Description
Delete a Migration object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Deleted |
|
404 |
Not Found |
No Content |
default |
Deleted |
Consumes
-
application/json
-
application/yaml
Produces
-
application/json
-
application/yaml
Patch a Migration object.
PATCH /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/migrations/{name}
Description
Patch a Migration object.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Patched |
|
404 |
Not Found |
No Content |
default |
Patched |
Produces
-
application/json-patch+json
Create a VirtualMachineReplicaSet object.
POST /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinereplicasets
Description
Create a VirtualMachineReplicaSet object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Created |
|
404 |
Not Found |
No Content |
Consumes
-
application/json
-
application/yaml
Produces
-
application/json
-
application/yaml
Get a list of VirtualMachineReplicaSet objects.
GET /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinereplicasets
Description
Get a list of VirtualMachineReplicaSet objects.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace' |
boolean |
Query |
export |
Should this value be exported. Export strips fields that a user can not specify. |
boolean |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
Delete a collection of VirtualMachineReplicaSet objects.
DELETE /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinereplicasets
Description
Delete a collection of VirtualMachineReplicaSet objects.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Deleted |
|
404 |
Not Found |
No Content |
default |
Deleted |
Produces
-
application/json
-
application/yaml
Get a VirtualMachineReplicaSet object.
GET /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinereplicasets/{name}
Description
Get a VirtualMachineReplicaSet object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace' |
boolean |
Query |
export |
Should this value be exported. Export strips fields that a user can not specify. |
boolean |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
Update a VirtualMachineReplicaSet object.
PUT /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinereplicasets/{name}
Description
Update a VirtualMachineReplicaSet object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Replaced |
|
404 |
Not Found |
No Content |
default |
Replaced |
Consumes
-
application/json
-
application/yaml
Produces
-
application/json
-
application/yaml
Delete a VirtualMachineReplicaSet object.
DELETE /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinereplicasets/{name}
Description
Delete a VirtualMachineReplicaSet object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Deleted |
|
404 |
Not Found |
No Content |
default |
Deleted |
Consumes
-
application/json
-
application/yaml
Produces
-
application/json
-
application/yaml
Patch a VirtualMachineReplicaSet object.
PATCH /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinereplicasets/{name}
Description
Patch a VirtualMachineReplicaSet object.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Patched |
|
404 |
Not Found |
No Content |
default |
Patched |
Produces
-
application/json-patch+json
Create a VirtualMachine object.
POST /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachines
Description
Create a VirtualMachine object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Created |
|
404 |
Not Found |
No Content |
Consumes
-
application/json
-
application/yaml
Produces
-
application/json
-
application/yaml
Get a list of VirtualMachine objects.
GET /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachines
Description
Get a list of VirtualMachine objects.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace' |
boolean |
Query |
export |
Should this value be exported. Export strips fields that a user can not specify. |
boolean |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
Delete a collection of VirtualMachine objects.
DELETE /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachines
Description
Delete a collection of VirtualMachine objects.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Deleted |
|
404 |
Not Found |
No Content |
default |
Deleted |
Produces
-
application/json
-
application/yaml
Get a VirtualMachine object.
GET /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachines/{name}
Description
Get a VirtualMachine object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace' |
boolean |
Query |
export |
Should this value be exported. Export strips fields that a user can not specify. |
boolean |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
Update a VirtualMachine object.
PUT /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachines/{name}
Description
Update a VirtualMachine object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Body |
body |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Replaced |
|
404 |
Not Found |
No Content |
default |
Replaced |
Consumes
-
application/json
-
application/yaml
Produces
-
application/json
-
application/yaml
Delete a VirtualMachine object.
DELETE /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachines/{name}
Description
Delete a VirtualMachine object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Deleted |
|
404 |
Not Found |
No Content |
default |
Deleted |
Consumes
-
application/json
-
application/yaml
Produces
-
application/json
-
application/yaml
Patch a VirtualMachine object.
PATCH /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachines/{name}
Description
Patch a VirtualMachine object.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Patched |
|
404 |
Not Found |
No Content |
default |
Patched |
Produces
-
application/json-patch+json
Open a websocket connection to a serial console on the specified VM.
GET /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachines/{name}/console
Description
Open a websocket connection to a serial console on the specified VM.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
console |
Name of the serial console to connect to |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
No Content |
Returns a remote-viewer configuration file. Run man 1 remote-viewer
to learn more about the configuration format.
GET /apis/kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachines/{name}/spice
Description
Returns a remote-viewer configuration file. Run man 1 remote-viewer
to learn more about the configuration format.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
name |
Name of the resource |
string |
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
remote-viewer configuration file |
No Content |
default |
remote-viewer configuration file |
No Content |
Produces
-
text/plain
-
application/json
-
application/yaml
Get a list of all VirtualMachineReplicaSet objects.
GET /apis/kubevirt.io/v1alpha1/virtualmachinereplicasets
Description
Get a list of all VirtualMachineReplicaSet objects.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
Get a list of all VirtualMachine objects.
GET /apis/kubevirt.io/v1alpha1/virtualmachines
Description
Get a list of all VirtualMachine objects.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
default |
OK |
Produces
-
application/json
-
application/yaml
Watch a MigrationList object.
GET /apis/kubevirt.io/v1alpha1/watch/migrations
Description
Watch a MigrationList object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
default |
OK |
Produces
-
application/json
Watch a Migration object.
GET /apis/kubevirt.io/v1alpha1/watch/namespaces/{namespace}/migrations
Description
Watch a Migration object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
default |
OK |
Produces
-
application/json
Watch a VirtualMachineReplicaSet object.
GET /apis/kubevirt.io/v1alpha1/watch/namespaces/{namespace}/virtualmachinereplicasets
Description
Watch a VirtualMachineReplicaSet object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
default |
OK |
Produces
-
application/json
Watch a VirtualMachine object.
GET /apis/kubevirt.io/v1alpha1/watch/namespaces/{namespace}/virtualmachines
Description
Watch a VirtualMachine object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
namespace |
Object name and auth scope, such as for teams and projects |
string |
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
default |
OK |
Produces
-
application/json
Watch a VirtualMachineReplicaSetList object.
GET /apis/kubevirt.io/v1alpha1/watch/virtualmachinereplicasets
Description
Watch a VirtualMachineReplicaSetList object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
default |
OK |
Produces
-
application/json
Watch a VirtualMachineList object.
GET /apis/kubevirt.io/v1alpha1/watch/virtualmachines
Description
Watch a VirtualMachineList object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
string |
Query |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything |
string |
Query |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
string |
Query |
timeoutSeconds |
TimeoutSeconds for the list/watch call. |
integer |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
default |
OK |
Produces
-
application/json