Jump to Content

v2

Documentation Log In

API Reference

v2API Reference

General

Getting Started with Project-FiFo API
Set Metadataput
Delete Metadatadelete
Cloud statusget

Sessions

Current Sessionget
One Time Tokenget
Token Deletiondelete
Cloud connection statusget

OAuth 2

Authorization Code Requestget
Authorization Code Grantpost
Implicit Requestget
Implicit Grantpost
Access Token Requestpost
Client Credentials - Access Token Requestpost
Refreshing an Access Tokenpost
Resource Owner Password Credentials Grantpost
List Scopesget

Users

List Usersget
Create Userpost
Get Userget
Set User Passwordput
Delete Userdelete
Test User Permissionget
Grant User Permissionsput
Revoke User Permissiondelete
Give Role to Userput
Remove Role from Userdelete
Add SSH Key to Userput
Remove SSH key from Userdelete
Add Yubikey to Userput
Remove Yubikey from Userdelete
Adds the User to an Organisationput
Remove User from Organistationdelete
Create API Keypost
Revoke Tokendelete

Clients

List Clientsget
Create Clientpost
Get Clientget
Set Client Secretput
Delete Clientdelete
Test Client Permissionsget
Grant Client Permissionsput
Revoke Client Permissionsdelete
Add Redirect URI to Clientpost
Remove Redirect URI from Clientdelete

Roles

List Rolesget
Create Rolepost
Get Roleget
Delete Roledelete
Grant Role Permissionsput
Revoke Role Permissionsdelete

Organisations

List Organizationsget
Create an Organizationpost
Get Organizationget
Get Accounting Dataget
Delete Organizationdelete
Add Trigger when a User is Createdpost
Add Trigger when a Dataset is Createdpost
Add Trigger when a VM is Createdpost
Delete Trigger from Organizationdelete

Hypervisors

List Hypervisorsget
Get Hypervisorget
Delete Hypervisordelete
Set Hypervisor Characteristicput
Delete Hypervisor Characteristicdelete
Set Hypervisor Configurationput

VMs

List VMsget
Create VMpost
Get VMget
Get VM Metricsget
Delete VMdelete
Dry run VM creationput
Change VM Power Stateput
Resize VMput
Update VM Configput
Change VM Ownershipput
Add NIC to VMpost
Remove NIC from VMdelete
Add Firewall Rule to VMpost
Remove Firewall Rule from VMpost
Snapshot a VMpost
Restore a VM Snapshotput
Delete a Snapshot form a VMdelete
Backup a VMpost
Delete a Backup of a VMdelete
Restore a VM Backupput
Change Service state.put
Get Hypervisor Metricsget
Removes a VM from a hypervisordelete

Networks

List Networksget
Create Networkpost
Get Networkget
Delete Networkdelete
Add an IP Range a Networkput
Remove an IP Range from a Networkdelete

IP Ranges

List IP Rangesget
Create IP Rangepost
Get IP Rangeget
Delete IP Rangedelete
Claim IP from IP Rangeput
Releases an IP Rangedelete

Datasets

List Datasetsget
Import Datasetpost
Get Datasetget
Delete Datasetdelete
Get Dataset zVolget
Upload Manifestput
Upload Dataset zVolput
Add NIC to Datasetput
Remove NIC from Datasetdelete

Packages

List Packagesget
Create Packagepost
Get Packageget
Delete Packagedelete

Powered by

General

Getting Started with Project-FiFo API
Set Metadataput
Delete Metadatadelete
Cloud statusget

Sessions

Current Sessionget
One Time Tokenget
Token Deletiondelete
Cloud connection statusget

OAuth 2

Authorization Code Requestget
Authorization Code Grantpost
Implicit Requestget
Implicit Grantpost
Access Token Requestpost
Client Credentials - Access Token Requestpost
Refreshing an Access Tokenpost
Resource Owner Password Credentials Grantpost
List Scopesget

Users

List Usersget
Create Userpost
Get Userget
Set User Passwordput
Delete Userdelete
Test User Permissionget
Grant User Permissionsput
Revoke User Permissiondelete
Give Role to Userput
Remove Role from Userdelete
Add SSH Key to Userput
Remove SSH key from Userdelete
Add Yubikey to Userput
Remove Yubikey from Userdelete
Adds the User to an Organisationput
Remove User from Organistationdelete
Create API Keypost
Revoke Tokendelete

Clients

List Clientsget
Create Clientpost
Get Clientget
Set Client Secretput
Delete Clientdelete
Test Client Permissionsget
Grant Client Permissionsput
Revoke Client Permissionsdelete
Add Redirect URI to Clientpost
Remove Redirect URI from Clientdelete

Roles

List Rolesget
Create Rolepost
Get Roleget
Delete Roledelete
Grant Role Permissionsput
Revoke Role Permissionsdelete

Organisations

List Organizationsget
Create an Organizationpost
Get Organizationget
Get Accounting Dataget
Delete Organizationdelete
Add Trigger when a User is Createdpost
Add Trigger when a Dataset is Createdpost
Add Trigger when a VM is Createdpost
Delete Trigger from Organizationdelete

Hypervisors

List Hypervisorsget
Get Hypervisorget
Delete Hypervisordelete
Set Hypervisor Characteristicput
Delete Hypervisor Characteristicdelete
Set Hypervisor Configurationput

VMs

List VMsget
Create VMpost
Get VMget
Get VM Metricsget
Delete VMdelete
Dry run VM creationput
Change VM Power Stateput
Resize VMput
Update VM Configput
Change VM Ownershipput
Add NIC to VMpost
Remove NIC from VMdelete
Add Firewall Rule to VMpost
Remove Firewall Rule from VMpost
Snapshot a VMpost
Restore a VM Snapshotput
Delete a Snapshot form a VMdelete
Backup a VMpost
Delete a Backup of a VMdelete
Restore a VM Backupput
Change Service state.put
Get Hypervisor Metricsget
Removes a VM from a hypervisordelete

Networks

List Networksget
Create Networkpost
Get Networkget
Delete Networkdelete
Add an IP Range a Networkput
Remove an IP Range from a Networkdelete

IP Ranges

List IP Rangesget
Create IP Rangepost
Get IP Rangeget
Delete IP Rangedelete
Claim IP from IP Rangeput
Releases an IP Rangedelete

Datasets

List Datasetsget
Import Datasetpost
Get Datasetget
Delete Datasetdelete
Get Dataset zVolget
Upload Manifestput
Upload Dataset zVolput
Add NIC to Datasetput
Remove NIC from Datasetdelete

Packages

List Packagesget
Create Packagepost
Get Packageget
Delete Packagedelete

Powered by

Cloud connection status

get https://example.com/cloud/connection

Returns connection status of the cloud services.

Language

Click Try It! to start a request and see the response here!