Skip to Content
vVozoraDocs
API reference

Endpoints

Every endpoint of the Vozora API, with the permission it needs and the fields it takes.

Every address below is relative to https://www.vozora.io. Fields in braces are part of the address; the rest go in a JSON body. This page is written from the API's own definition, as is /openapi.json.

Account and billing

GET /api/v1/account

The account this key belongs to, the key itself and what it may do.

Any valid key.

GET /api/v1/billing

Credit balance in pounds, what the account's hourly servers cost per hour, usage so far this month and credit history.

Permission: billing:read.

Sizes and images

GET /api/v1/plans

Server sizes on sale, with their hourly price in pounds.

Permission: servers:read.

GET /api/v1/images

Operating system images a server can be created from.

Permission: servers:read.

Servers

GET /api/v1/servers

Every server in the account.

Permission: servers:read.

POST /api/v1/servers

Create an hourly server, paid from credit. It is returned at once in state "starting"; read it again until it is "running". The account needs credit for 24 hours of all its servers.

Permission: servers:write. Spends credit.

FieldTypeNotes
namestringRequired. Letters, digits and hyphens, starting with a letter. Unique in the account.
planstringRequired. A size's name or id, from /plans.
imagestringRequired. An image's name or id, from /images.
ssh_keystringRequired. The name of a saved SSH key, from /ssh-keys.
firewallsstring[]Optional. Firewall names. Omitted: the default firewall.
waive_cancellation_righttrueRequired. Must be true: the server starts at once, so you give up the 14-day right to cancel it for a refund.

GET /api/v1/servers/{id}

One server. To connect: ssh <login_user>@<ipv4> with its SSH key, then sudo for root. There is no root password.

Permission: servers:read.

DELETE /api/v1/servers/{id}

Delete a server and its backups for good; it answers once the server is gone (up to two minutes). A monthly server is instead set to end with its paid period, and is returned with cancel_at set.

Permission: servers:write. Cannot be undone.

POST /api/v1/servers/{id}/power

Stop, start or reboot a server. A stopped server costs the same as a running one.

Permission: servers:write.

FieldTypeNotes
actionstop | start | rebootRequired.

POST /api/v1/servers/{id}/resize

Move a stopped hourly server to a larger size. A disk cannot shrink, so there is no way back down.

Permission: servers:write. Spends credit.

FieldTypeNotes
planstringRequired. A larger size's name or id, from /plans.

POST /api/v1/servers/{id}/reinstall

Replace a server's disk with a fresh operating system. Everything on it and all its backups are lost; its name, addresses and size stay.

Permission: servers:write. Cannot be undone.

FieldTypeNotes
imagestringRequired. An image's name or id, from /images.
ssh_keystringOptional. Another saved SSH key to install. The server must be stopped to change it.

PUT /api/v1/servers/{id}/firewalls

Set which firewalls a stopped server is in.

Permission: servers:write.

FieldTypeNotes
firewallsstring[]Required.

GET /api/v1/servers/{id}/reverse-dns

The host name a server's addresses resolve back to.

Permission: servers:read.

PUT /api/v1/servers/{id}/reverse-dns

Set the host name a server's addresses resolve back to, for mail servers. An empty name clears it.

Permission: servers:write.

FieldTypeNotes
namestringRequired.

GET /api/v1/servers/{id}/backups

A server's backups, newest first, and whether a daily backup is on.

Permission: servers:read.

POST /api/v1/servers/{id}/backups

Start a backup of a server's disk now. It appears in the list as it completes.

Permission: servers:write. Spends credit.

PUT /api/v1/servers/{id}/backups/daily

Turn a server's daily backup on or off. The newest seven are kept; turning it off keeps those already taken.

Permission: servers:write. Spends credit.

FieldTypeNotes
enabledbooleanRequired.

POST /api/v1/servers/{id}/backups/{backup}/restore

Put a stopped server's disk back to how it was when a backup was taken. Everything since is lost.

Permission: servers:write. Cannot be undone.

DELETE /api/v1/servers/{id}/backups/{backup}

Delete one backup.

Permission: servers:write. Cannot be undone.

SSH keys

GET /api/v1/ssh-keys

Saved SSH public keys.

Permission: ssh_keys:read.

POST /api/v1/ssh-keys

Save an SSH public key under a name, to put on new servers.

Permission: ssh_keys:write.

FieldTypeNotes
namestringRequired. Letters, digits and hyphens.
public_keystringRequired. The contents of a .pub file.

GET /api/v1/ssh-keys/{name}

One saved SSH key.

Permission: ssh_keys:read.

DELETE /api/v1/ssh-keys/{name}

Delete a saved SSH key. Servers already created with it keep it.

Permission: ssh_keys:write. Cannot be undone.

Firewalls

GET /api/v1/firewalls

Firewalls and their rules. A firewall blocks all inbound traffic that no rule allows; outbound is open.

Permission: firewalls:read.

POST /api/v1/firewalls

Create an empty firewall, which allows nothing in until rules are added.

Permission: firewalls:write.

FieldTypeNotes
namestringRequired. Up to 32 letters, digits and hyphens, starting with a letter.

GET /api/v1/firewalls/{name}

One firewall and its rules.

Permission: firewalls:read.

DELETE /api/v1/firewalls/{name}

Delete a firewall no server is in. The default firewall cannot be deleted.

Permission: firewalls:write. Cannot be undone.

POST /api/v1/firewalls/{name}/rules

Allow inbound traffic through a firewall. Takes effect at once on every server in it.

Permission: firewalls:write.

FieldTypeNotes
protocoltcp | udp | icmp | allRequired. icmp allows ping; all allows every protocol and port.
portsstringOptional. For tcp and udp: one port ("443") or a range ("8000-8100").
cidrstringRequired. The source: an IPv4 or IPv6 range such as 0.0.0.0/0, ::/0 or 203.0.113.7/32. An IPv4 range does not cover IPv6.

DELETE /api/v1/firewalls/{name}/rules/{rule}

Remove a rule from a firewall.

Permission: firewalls:write. Cannot be undone.

Private networks

GET /api/v1/networks

Private networks and the servers on them.

Permission: networks:read.

POST /api/v1/networks

Create a private network, with its own address range, for servers to reach each other on.

Permission: networks:write. Spends credit.

FieldTypeNotes
namestringRequired. Letters, digits and hyphens, starting with a letter. Unique in the account.

GET /api/v1/networks/{id}

One private network.

Permission: networks:read.

DELETE /api/v1/networks/{id}

Delete a private network that has no servers on it.

Permission: networks:write. Cannot be undone.

PUT /api/v1/networks/{id}/servers/{server}

Put a server on a private network. It gets an address there by DHCP. Can take a minute for a network's first server.

Permission: networks:write.

DELETE /api/v1/networks/{id}/servers/{server}

Take a server off a private network.

Permission: networks:write.

Volumes and snapshots

GET /api/v1/volumes

Volumes: extra disks that can be moved between servers.

Permission: volumes:read.

POST /api/v1/volumes

Create a volume, either empty at a size in GB or holding a snapshot's contents.

Permission: volumes:write. Spends credit.

FieldTypeNotes
namestringRequired. Letters, digits and hyphens, starting with a letter. Unique in the account.
size_gbintegerOptional.
snapshot_idstringOptional.

GET /api/v1/volumes/{id}

One volume.

Permission: volumes:read.

DELETE /api/v1/volumes/{id}

Delete a detached volume and everything on it. Its snapshots are kept.

Permission: volumes:write. Cannot be undone.

PUT /api/v1/volumes/{id}/server

Attach a volume to a server. It appears there as a new disk to format and mount.

Permission: volumes:write.

FieldTypeNotes
server_idstringRequired.

DELETE /api/v1/volumes/{id}/server

Detach a volume from its server. Unmount it inside the server first.

Permission: volumes:write.

GET /api/v1/snapshots

Snapshots of volumes.

Permission: volumes:read.

POST /api/v1/volumes/{id}/snapshots

Start a snapshot of a volume. It appears in the list as it completes.

Permission: volumes:write. Spends credit.

FieldTypeNotes
namestringRequired. Letters, digits and hyphens, starting with a letter.

DELETE /api/v1/snapshots/{id}

Delete a snapshot.

Permission: volumes:write. Cannot be undone.

DNS

GET /api/v1/dns/zones

Domains hosted on Vozora DNS, with their records and the nameservers to point each domain at.

Permission: dns:read.

POST /api/v1/dns/zones

Add a domain. It answers once the domain's registrar points it at the nameservers returned; until then it is unverified.

Permission: dns:write.

FieldTypeNotes
namestringRequired. A domain you control, such as example.com.

GET /api/v1/dns/zones/{id}

One domain and its records.

Permission: dns:read.

DELETE /api/v1/dns/zones/{id}

Delete a domain and all its records. It stops answering at once.

Permission: dns:write. Cannot be undone.

PUT /api/v1/dns/zones/{id}/records/{type}/{name}

Set every value of one name and type, replacing what was there. Use the name @ for the domain itself.

Permission: dns:write.

FieldTypeNotes
ttlintegerOptional. Seconds, 60 to 86400. Omitted: 3600.
valuesstring[]Required. A: IPv4 addresses. AAAA: IPv6 addresses. CNAME, NS: a host name. MX: "10 mail.example.com". SRV: "10 5 5060 sip.example.com". TXT: plain text without commas, quotes or backslashes.

DELETE /api/v1/dns/zones/{id}/records/{type}/{name}

Remove every value of one name and type.

Permission: dns:write. Cannot be undone.

Object storage

GET /api/v1/buckets

Object storage buckets, how much each holds, and the S3 endpoint to connect to.

Permission: storage:read.

POST /api/v1/buckets

Create a private bucket. Bucket names are shared by every customer, like domain names.

Permission: storage:write. Spends credit.

FieldTypeNotes
namestringRequired. 3 to 63 lowercase letters, digits and hyphens.
limit_gbintegerRequired. The most the bucket may hold, 1 to 1024 GB. It can be raised later.
versioningbooleanOptional.

GET /api/v1/buckets/{id}

One bucket.

Permission: storage:read.

PATCH /api/v1/buckets/{id}

Change a bucket's size limit, versioning, or whether anyone may read and list it without a key.

Permission: storage:write.

FieldTypeNotes
limit_gbintegerOptional.
versioningbooleanOptional.
publicbooleanOptional. true lets anyone with the address read and list every object.

DELETE /api/v1/buckets/{id}

Delete a bucket and every object in it.

Permission: storage:write. Cannot be undone.

GET /api/v1/storage/key

The S3 access key and secret for all of the account's buckets. There is none before the first bucket.

Permission: storage_keys:read.

POST /api/v1/storage/key/rotate

Replace the S3 key. The old one stops working at once.

Permission: storage_keys:write. Cannot be undone.

Vozora is a trading name of Bankside Technology Ltd, company no. 17253446.TermsPrivacysupport@vozora.io