Skip to main content
New to Corsair? See API access, authentication, and error handling.

Account

getUser

account.getUser Read the authenticated user and profile Risk: read
Input: empty object Output

sshKeys.create

account.sshKeys.create Add an SSH public key Risk: write
Input Output

sshKeys.delete

account.sshKeys.delete Delete an SSH key Risk: destructive
Input Output: any

sshKeys.list

account.sshKeys.list List the SSH public keys of the user Risk: read
Input: empty object Output: object[]

sshKeys.rename

account.sshKeys.rename Rename an SSH key Risk: write
Input Output

tokens.delete

account.tokens.delete Delete an API token Risk: destructive
Input Output: empty object

tokens.list

account.tokens.list List the API tokens of the user Risk: read
Input: empty object Output: object[]

tokens.update

account.tokens.update Update a token description or restriction Risk: write
Input Output

updateProfile

account.updateProfile Update the user profile fields Risk: write
Input Output

Config

getPricingPolicy

config.getPricingPolicy Read the pricing policy lines Risk: read
Input: empty object Output

listAppCatalogImages

config.listAppCatalogImages List the app catalog images Risk: read
Input: empty object Output: object[]

listBootImages

config.listBootImages List bootable media images Risk: read
Input: empty object Output: object[]

listLocations

config.listLocations List the Pilvio data centre locations Risk: read
Input: empty object Output: object[]

listPlainOsImages

config.listPlainOsImages List the plain OS images Risk: read
Input: empty object Output: object[]

listResourcePools

config.listResourcePools List VM server classes (resource pools) Risk: read
Input: empty object Output: object[]

listVmImages

config.listVmImages List the VM image catalog Risk: read
Input: empty object Output: object[]

Network

firewalls.create

network.firewalls.create Create a firewall with rules Risk: write
Input Rules take protocol tcp/udp/icmp, direction inbound/outbound, a port range and endpointSpecType ip_prefixes (with CIDR list) or any.
Output

firewalls.delete

network.firewalls.delete Delete a firewall Risk: destructive
Input Output: any

firewalls.list

network.firewalls.list List the firewalls and their rules Risk: read
Input Output: object[]

networks.create

network.networks.create Create a private network Risk: write
Input Output

networks.delete

network.networks.delete Delete an empty, non-default network Risk: destructive
Input 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
Input Output

networks.list

network.networks.list List the private networks Risk: read
Input Output: object[]

Storage

buckets.create

storage.buckets.create Create an S3 bucket with a globally unique name Risk: destructive
Input 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
Input Output: any

buckets.get

storage.buckets.get Read one bucket by name Risk: read
Input Output

buckets.list

storage.buckets.list List the object storage buckets Risk: read
Input: empty object Output: object[]

buckets.update

storage.buckets.update Move a bucket to another billing account Risk: write
Input Output

disks.create

storage.disks.create Create a disk from empty, an OS image, a disk or a snapshot Risk: destructive
Input 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

disks.delete

storage.disks.delete Delete a disk Risk: destructive
Input Output: any

disks.get

storage.disks.get Read one disk by UUID Risk: read
Input Output

disks.list

storage.disks.list List the block storage disks Risk: read
Input Output: object[]

disks.update

storage.disks.update Update disk metadata Risk: write
Input Output

Vm

create

vm.create Create a virtual machine from an image or source Risk: destructive
Input 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

delete

vm.delete Delete a virtual machine Risk: destructive
Input Output: empty object

get

vm.get Read one VM by UUID Risk: read
Input Output

list

vm.list List the virtual machines Risk: read
Input Output: object[]

reinstall

vm.reinstall Reinstall a VM with a new OS; existing data is replaced Risk: destructive
Input Destructive: the VM is reinstalled with the new OS and existing data is replaced. Output

start

vm.start Start a stopped VM; billing for it resumes Risk: destructive
Input Output

stop

vm.stop Stop a running VM Risk: write
Input Output