New to Corsair? See API access, authentication, and error handling.
Account
getUser
account.getUser
Read the authenticated user and profile
Risk: read
profile full type
profile full type
sshKeys.create
account.sshKeys.create
Add an SSH public key
Risk: write
Output
sshKeys.delete
account.sshKeys.delete
Delete an SSH key
Risk: destructive
Output:
any
sshKeys.list
account.sshKeys.list
List the SSH public keys of the user
Risk: read
object[]
Output full type
Output full type
sshKeys.rename
account.sshKeys.rename
Rename an SSH key
Risk: write
Output
tokens.delete
account.tokens.delete
Delete an API token
Risk: destructive
Output: empty object
tokens.list
account.tokens.list
List the API tokens of the user
Risk: read
object[]
Output full type
Output full type
tokens.update
account.tokens.update
Update a token description or restriction
Risk: write
Output
updateProfile
account.updateProfile
Update the user profile fields
Risk: write
Output
profile full type
profile full type
Config
getPricingPolicy
config.getPricingPolicy
Read the pricing policy lines
Risk: read
policy full type
policy full type
listAppCatalogImages
config.listAppCatalogImages
List the app catalog images
Risk: read
object[]
Output full type
Output full type
listBootImages
config.listBootImages
List bootable media images
Risk: read
object[]
Output full type
Output full type
listLocations
config.listLocations
List the Pilvio data centre locations
Risk: read
object[]
Output full type
Output full type
listPlainOsImages
config.listPlainOsImages
List the plain OS images
Risk: read
object[]
Output full type
Output full type
listResourcePools
config.listResourcePools
List VM server classes (resource pools)
Risk: read
object[]
Output full type
Output full type
listVmImages
config.listVmImages
List the VM image catalog
Risk: read
object[]
Output full type
Output full type
Network
firewalls.create
network.firewalls.create
Create a firewall with rules
Risk: write
Rules take protocol tcp/udp/icmp, direction inbound/outbound, a port range and endpointSpecType ip_prefixes (with CIDR list) or any.
rules full type
rules full type
rules full type
rules full type
firewalls.delete
network.firewalls.delete
Delete a firewall
Risk: destructive
Output:
any
firewalls.list
network.firewalls.list
List the firewalls and their rules
Risk: read
Output:
object[]
Output full type
Output full type
networks.create
network.networks.create
Create a private network
Risk: write
Output
networks.delete
network.networks.delete
Delete an empty, non-default network
Risk: destructive
Only works when the network holds no resources and is not the user default.
Output:
any
networks.get
network.networks.get
Read one network by UUID
Risk: read
Output
networks.list
network.networks.list
List the private networks
Risk: read
Output:
object[]
Output full type
Output full type
Storage
buckets.create
storage.buckets.create
Create an S3 bucket with a globally unique name
Risk: destructive
Bucket names follow S3 naming rules and are globally unique across all Pilvio users.
Output
buckets.delete
storage.buckets.delete
Delete a bucket
Risk: destructive
Output:
any
buckets.get
storage.buckets.get
Read one bucket by name
Risk: read
Output
buckets.list
storage.buckets.list
List the object storage buckets
Risk: read
object[]
Output full type
Output full type
buckets.update
storage.buckets.update
Move a bucket to another billing account
Risk: write
Output
disks.create
storage.disks.create
Create a disk from empty, an OS image, a disk or a snapshot
Risk: destructive
source_image_type EMPTY needs no source; OS_BASE takes e.g. ubuntu_20.04, DISK and SNAPSHOT take a UUID. sizeGb is required when the size is not apparent from the source image.
Output
snapshots full type
snapshots full type
disks.delete
storage.disks.delete
Delete a disk
Risk: destructive
Output:
any
disks.get
storage.disks.get
Read one disk by UUID
Risk: read
Output
snapshots full type
snapshots full type
disks.list
storage.disks.list
List the block storage disks
Risk: read
Output:
object[]
Output full type
Output full type
disks.update
storage.disks.update
Update disk metadata
Risk: write
Output
snapshots full type
snapshots full type
Vm
create
vm.create
Create a virtual machine from an image or source
Risk: destructive
osName/osVersion come from config.listVmImages; use osName “custom” and osVersion "" for an empty disk booted from an ISO. cloudInit takes a YAML or JSON object as a string and overrides username/password.
Output
storage full type
storage full type
delete
vm.delete
Delete a virtual machine
Risk: destructive
Output: empty object
get
vm.get
Read one VM by UUID
Risk: read
Output
storage full type
storage full type
list
vm.list
List the virtual machines
Risk: read
Output:
object[]
Output full type
Output full type
reinstall
vm.reinstall
Reinstall a VM with a new OS; existing data is replaced
Risk: destructive
Destructive: the VM is reinstalled with the new OS and existing data is replaced.
Output
storage full type
storage full type
start
vm.start
Start a stopped VM; billing for it resumes
Risk: destructive
Output
storage full type
storage full type
stop
vm.stop
Stop a running VM
Risk: write
Output
storage full type
storage full type