API docs by Redocly

Flintlock MicroVM API (0.1)

Download OpenAPI specification:Download

The Flintlock MicroVM API handles operations for provisioning and managing microvms

MicroVM

MicroVM_CreateMicroVM

query Parameters
metadata
string

This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18

Request Body schema: application/json
required
id
string

ID is the identifier of the microvm. If this empty at creation time a ID will be automatically generated.

namespace
string

Namespace is the name of the namespace the microvm belongs to.

object

Labels allows you to include extra data for the microvms.

vcpu
integer <int32>

VCPU specifies how many vcpu the machine will be allocated.

memoryInMb
integer <int32>

MemoryInMb is the amount of memory in megabytes that the machine will be allocated.

object (typesKernel)

Kernel represents the configuration for a kernel.

object (typesInitrd)

Initrd represents the configuration for the initial ramdisk.

object (typesVolume)

Volume represents the configuration for a volume to be attached to a microvm.

Array of objects (typesVolume)

AdditionalVolumes specifies the volumes to be attached to the microvm.

Array of objects (typesNetworkInterface)

Interfaces specifies the network interfaces to be attached to the microvm. Device names on the guest machine are determined by the order defined in the list starting from eth1, eth2, ..., ethN.

object

Metadata allows you to specify data to be added to the metadata service. The key is the name of the metadata item and the value is the base64 encoded contents of the metadata.

createdAt
string <date-time>

CreatedAt indicates the time the microvm was created at.

updatedAt
string <date-time>

UpdatedAt indicates the time the microvm was last updated.

deletedAt
string <date-time>

DeletedAt indicates the time the microvm was marked as deleted.

uid
string

UID is a globally unique identifier of the microvm.

provider
string

Provider allows you to specify the name of the microvm provider to use. If this isn't supplied then the default provider will be used.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "namespace": "string",
  • "labels": {
    },
  • "vcpu": 0,
  • "memoryInMb": 0,
  • "kernel": {
    },
  • "initrd": {
    },
  • "rootVolume": {
    },
  • "additionalVolumes": [
    ],
  • "interfaces": [
    ],
  • "metadata": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "uid": "string",
  • "provider": "string"
}

Response samples

Content type
application/json
{
  • "microvm": {
    }
}

MicroVM_ListMicroVMs

path Parameters
namespace
required
string
query Parameters
name
string

Responses

Response samples

Content type
application/json
{
  • "microvm": [
    ]
}

MicroVM_GetMicroVM

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "microvm": {
    }
}

MicroVM_DeleteMicroVM

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{ }