Jump to Content
Guides
API
API (old)
Guides
API Reference
Changelog
Discussions
v0.7.0
v0.7.1
v0.7.2
v0.8.0
v0.8.1
v0.8.2
v0.8.3
v0.9.0
v0.9.1
v0.9.2
v0.9.3
Guides
API
API (old)
Log In
API Reference
Log In
Brainy Briard
API Reference
parameters
Search
JUMP TO
Hypervisors
/
get
get
/{uuid}
get
get
delete
delete
/{uuid}/characteristics/{path}
put
put
delete
delete
/{uuid}/config
put
put
/{uuid}/metrics
get
get
VMs
/
get
get
post
post
/{uuid}
get
get
delete
delete
/dry_run
post
post
/{uuid}/state
put
put
/{uuid}/console
put
put
/{uuid}/package
put
put
/{uuid}/config
put
put
/{uuid}/owner
put
put
/{uuid}/nics
post
post
/{uuid}/nics/{mac}
delete
delete
/{uuid}/hostname/{nic}
put
put
/{uuid}/fw_rules
post
post
/{uuid}/fw_rules/{rule_id}
post
post
/{uuid}/snapshots
post
post
/{uuid}/snapshots/{snap-id}
put
put
/{uuid}/nis/{snap-id}
delete
delete
/{uuid}/backups
post
post
/{uuid}/backups/{backup-id}
parameters
get
get
put
put
delete
delete
/{uuid}/services
put
put
/{uuid}/metrics
get
get
/{uuid}/hypervisor
delete
delete
Sessions
/
delete
delete
sessions
retrieves information about the current session
get
/one_time_token
get
get
Scopes
/
get
get
Clients
/
get
get
post
post
/{uuid}
get
get
put
put
delete
delete
/{uuid}/permissions/{permission}
get
get
put
put
delete
delete
/{uuid}/uris
post
post
/{uuid}/uris/{id}
delete
delete
Datasets
/
get
get
post
post
/{uuid}
get
get
delete
delete
put
put
/{uuid}/dataset.gz
get
get
put
put
/{uuid}/networks/{nic}
put
put
delete
delete
Groupings
/
get
get
/{uuid}
get
get
/{uuid}/elements/{other}
put
put
delete
delete
/{uuid}/config/{path}
put
put
delete
delete
/{uuid}/metadata/{path}
put
put
delete
delete
OAuth2
/auth
get
get
post
post
/token
post
post
Networks
/
get
get
post
post
/{uuid}
get
get
delete
delete
/{uuid}/iprange/{iprange}
put
put
delete
delete
Organizations
/
get
get
post
post
/{uuid}
get
get
delete
delete
/{uuid}/accounting
get
get
/{uuid}/triggers/user_create
put
put
/{uuid}/triggers/dataset_create
post
post
/{uuid}/triggers/vm_create
put
put
/{uuid}/triggers/{trigger-id}
delete
delete
/{uuid}/resources/{resource}
put
put
/{uuid}/docker/networks/{scope}
put
put
Users
/
get
get
post
post
/user/{uuid}
get
get
put
put
delete
delete
/user/{uuid}/permissions/{permission}
get
get
put
put
delete
delete
/user/{uuid}/role/{role}
put
put
delete
delete
/{uuid}/keys
put
put
/{uuid}/keys/{key-id}
delete
delete
/{uuid}/yubikeys
put
put
/{uuid}/yubikeys/{key-id}
delete
delete
/{uuid}/orgs/{org}
put
put
delete
delete
/{uuid}/tokens
post
post
/{uuid}/tokens/{token-id}
delete
delete
Roles
/
get
get
post
post
/{uuid}
get
get
delete
delete
/{uuid}/permissions/{permission}
put
put
delete
delete
Packages
/
get
get
post
post
/{uuid}
get
get
delete
delete
IP-Ranges
/
get
get
post
post
/{uuid}
get
get
put
put
/{uuid}/{ip}
put
put
Powered by
parameters