Swagger UI

FiFo.cloud

1.0

[ Base URL: fifo.cloud:443 ]

https://fifo.cloud/api/v1/swagger/fifo.json

Schemes

Models

VMs[
title: VMs

A collection of VMs

#/definitions/VMVM{...}]

#/definitions/VMCreateReqVM Crate request{

description:

The Configuration of a VM

resolvers

[

Resolvers

string]

package*

string

UUID of the package to use

network*

string

UUID of the network to use

metadata

{

description:

Metadat

}

maintain_resolvers

boolean

Weather to maintain resolvers

hostname*

string

Hostname for the VM

delegate_dataset

boolean

If a delegated ZFS dataset should be cratred (zones only)

dataset*

string

UUID of the dataset to use

alias*

string

Alias for the VM

}

#/definitions/VMConfigVM configuration{

description:

The Configuration of a VM

}

#/definitions/VMVM{

description:

A VM, jail or zone

uuid*

string

Unique identifier

state*

string

State of the VM

snapshots

{

description:

Snapshots

}

package*

string

UUID of the package

metadata*

{

description:

FiFo Metadata

}

hypervisor*

string

UUID of the hypervisor

groupings*

[

List of groupings the VM is in

string]

dataset*

string

UUID of the dataset

config*

#/definitions/VMConfigVM configuration{

description:

The Configuration of a VM

}

alias*

string

Alias of the VM

}

#/definitions/StateChangeReqState change request{

description:	State change request
state*	string State to transition to Enum: Array [ 3 ]

}

#/definitions/SnapshotCreateReqSnapshot create request{

description:	Request to create a snapshot
comment*	string Comment for the snapshot

}

#/definitions/RequirementRequirement{

description:	A package requirement
weight*	string Either one of the condition strings or a number for ranking Enum: Array [ 4 ]
value	string The value to cehck against, either a string or number
low	integer Low value for scale
high	integer High value for scale
condition*	string Condition used to compare the value Enum: Array [ 6 ]
attribute*	string the atribute the atribute to match, this can be a dot seperated path.

}

Packages[
title: Packages

A collection of Packages

#/definitions/PackagePackage{...}]

#/definitions/PackageCreateReqPackage create request{

description:	Package create request
ram*	integer Memory quota the package gets, in MB
quota*	integer Disk Quota in GB
name*	string Alias for the Package
cpu_cap	integer CPU Cores the package gets, in % of cores
compression	string Compression to use Enum: Array [ 6 ]

}

#/definitions/PackageChangeReqPackage change request{

description:	Package change request
package*	string New package UUID

}

#/definitions/PackagePackage{

description:	A package
uuid*	string Unique identifier
ram*	integer Memory in MB
quota*	integer Disk space in GB
name*	string Users name
cpu_cap*	integer Percentage of CPU cures

}

#/definitions/NicAddReqPackage change request{

description:	Package change request
network*	string UUID of the new network

}

Networks[
title: Networks

A collection of Networks

#/definitions/NetworkNetwork{...}]

#/definitions/NetworkIPReqNetwork create request{

description:	Network create request
ip*	string IP

}

#/definitions/NetworkCreateReqNetwork create request{

description:	Network create request
vlan	integer VLAN ID
subnet*	string The subnet IP
resolvers	[ List of resolvers if any string]
nic_tag*	string NIC tag to use
netmask*	string The netmask (in full form)
name*	string Alias for the Network
last*	string Last IP of the network
gateway*	string The gateway IP
first*	string First IP of the network

}

#/definitions/NetworkNetwork{

description:	A network
uuid*	string Unique identifier
resolvers	[ List of resolvers if any string]
name*	string Users name
delete_script	string Script to be executed on vm creation
create_script	string Script to be executed on vm creation

}

#/definitions/MetadataChangeReqMetadata change request{

description:	Metadata change request
value*	stringnumberboolean value
path*	[ Path to the value string]

}

Hosts[
title: Hosts

A collection of Hosts

#/definitions/HostHost{...}]

#/definitions/HostResourcesHost Resources{

description:

Resources on a host

}

#/definitions/HostCharacteristicsHost Resources{

description:

Resources on a host

}

#/definitions/HostAddReqHost add request{

description:	The host config
region	string Region of the host
alias*	string Alias for the VM

}

#/definitions/HostHost{

description:

A host

virtualisation*

[

Available virtualisation methods

stringEnum:
Array [ 3 ]]

uuid*

string

Unique identifier

resources*

#/definitions/HostResourcesHost Resources{

description:

Resources on a host

}

networks*

[

Networks on the host

string]

name*

string

Name of the host

last_seen*

integer

Last seen timestamp

install_path*

string

Path to the install script

characteristics*

#/definitions/HostCharacteristicsHost Resources{

description:

Resources on a host

}

architecture*

string

Architecture

alias*

string

Alias of the host

}

Datasets[
title: Datasets

A collection of Datasets

#/definitions/DatasetDataset{...}]

Dataset import request{

description:	Dataset import reques
url*	string URL of of the dataset to import

}

#/definitions/DatasetDataset{

description:	A dataset
version*	string Version of the dataset
uuid*	string Unique identifier
type*	string Type of the dataset
status*	string Status of the import
os*	string Type of the dataset
name*	string Name of the dataset
image_size	integer Size of the dataset

}

#/definitions/ConfigChangeReqConfig change request{

description:	Config change request
resolvers	[ Resolvers string]
maintain_resolvers	boolean Weather
alias	string New alias

}

#/definitions/BackupCreateReqSnapshot create request{

description:	Request to create a snapshot
delete*	boolean For incremental backups weather the parent gets removed from the host, for non incremental backups of this snapshot gets removed from the host
comment*	string Comment for the snapshot

}