# Onidel Cloud API

## Docs

- [Authentication](https://developers.onidel.com/api-reference/authentication.md): How to create an API token and use it to authenticate with Onidel
- [Generate backup download URL](https://developers.onidel.com/api-reference/backups/generate-backup-download-url.md): Generate backup download URL
- [List backups](https://developers.onidel.com/api-reference/backups/list-backups.md): List backups available to the user
- [Create Firewall Rule](https://developers.onidel.com/api-reference/firewall-rule/create-firewall-rule.md): Add a new rule to a firewall group.
- [Delete Firewall Rule](https://developers.onidel.com/api-reference/firewall-rule/delete-firewall-rule.md): Delete a firewall rule from a group
- [Get Firewall Rule by ID](https://developers.onidel.com/api-reference/firewall-rule/get-firewall-rule-by-id.md): Retrieve a specific firewall rule
- [List Firewall Rules](https://developers.onidel.com/api-reference/firewall-rule/list-firewall-rules.md): Retrieve all rules in a firewall group
- [Update Firewall Rule](https://developers.onidel.com/api-reference/firewall-rule/update-firewall-rule.md): Update a firewall rule's description (max 255 characters)
- [Create Firewall Group](https://developers.onidel.com/api-reference/firewall/create-firewall-group.md): Create a new firewall group
- [Delete Firewall Group](https://developers.onidel.com/api-reference/firewall/delete-firewall-group.md): Delete a firewall group. Cannot delete if VMs are still attached.
- [Get Firewall Group by ID](https://developers.onidel.com/api-reference/firewall/get-firewall-group-by-id.md): Retrieve a specific firewall group by its UUID
- [List Firewall Groups](https://developers.onidel.com/api-reference/firewall/list-firewall-groups.md): Retrieve all firewall groups for a team
- [Update Firewall Group](https://developers.onidel.com/api-reference/firewall/update-firewall-group.md): Update a firewall group's description
- [Get VM Price](https://developers.onidel.com/api-reference/instance-price/get-vm-price.md): Get VM price based on the specified VM configuration parameters.
- [List Instance Types](https://developers.onidel.com/api-reference/instance-type/list-instance-types.md): List instance types available for provision
- [Add Entry to IP List](https://developers.onidel.com/api-reference/ip-list/add-entry-to-ip-list.md): Add an IP address or CIDR to an IP list. Type is auto-detected if not provided. Supports IPv4 and IPv6 addresses and CIDR ranges. The `/0` prefix is not allowed.
- [Create IP List](https://developers.onidel.com/api-reference/ip-list/create-ip-list.md): Create a new IP list. Limit per team is configurable.
- [Delete Entry from IP List](https://developers.onidel.com/api-reference/ip-list/delete-entry-from-ip-list.md): Remove an entry from an IP list
- [Delete IP List](https://developers.onidel.com/api-reference/ip-list/delete-ip-list.md): Delete an IP list. All firewall rules referencing this list will also be removed.
- [Get IP List by ID](https://developers.onidel.com/api-reference/ip-list/get-ip-list-by-id.md): Retrieve a specific IP list with all its entries
- [List IP Lists](https://developers.onidel.com/api-reference/ip-list/list-ip-lists.md): Retrieve all IP lists for a team
- [Update IP List](https://developers.onidel.com/api-reference/ip-list/update-ip-list.md): Update an IP list's name or description
- [Create a Bucket](https://developers.onidel.com/api-reference/object-storage/create-a-bucket.md): Create a new bucket in the object storage service
- [Get Bucket Access Keys](https://developers.onidel.com/api-reference/object-storage/get-bucket-access-keys.md): Retrieve access keys for a specific bucket
- [Get Object Storage Service](https://developers.onidel.com/api-reference/object-storage/get-object-storage-service.md): Retrieve details of a specific object storage service
- [List Object Storage Services](https://developers.onidel.com/api-reference/object-storage/list-object-storage-services.md): Retrieve all object storage services for the team
- [List OS Templates](https://developers.onidel.com/api-reference/os-template/list-os-templates.md): List prebuilt OS images available for installation.
- [Convert VM's primary IP to reserved IP](https://developers.onidel.com/api-reference/reserved-ips/convert-vms-primary-ip-to-reserved-ip.md): Convert an existing VM's primary public IP address into a reserved IP (floating IP)
- [Create a new reserved IP](https://developers.onidel.com/api-reference/reserved-ips/create-a-new-reserved-ip.md): Allocate a new reserved IP address in the specified location
- [Delete a reserved IP](https://developers.onidel.com/api-reference/reserved-ips/delete-a-reserved-ip.md): Terminate a reserved IP and release it back to the pool. Will automatically detach from VM if attached.
- [Get a specific reserved IP](https://developers.onidel.com/api-reference/reserved-ips/get-a-specific-reserved-ip.md): Retrieve details of a specific reserved IP by ID
- [List reserved IPs](https://developers.onidel.com/api-reference/reserved-ips/list-reserved-ips.md): Get all reserved IPs for the authenticated user's team or specified team
- [Update reserved IP (rename or attach/detach VM)](https://developers.onidel.com/api-reference/reserved-ips/update-reserved-ip-rename-or-attachdetach-vm.md): Update reserved IP properties - rename it or attach/detach it to/from a VM
- [Delete a snapshot](https://developers.onidel.com/api-reference/snapshots/delete-a-snapshot.md): Delete a snapshot
- [Generate snapshot download URL](https://developers.onidel.com/api-reference/snapshots/generate-snapshot-download-url.md): Generate snapshot download URL
- [List snapshots](https://developers.onidel.com/api-reference/snapshots/list-snapshots.md): List snapshots available to the user
- [Create a new SSH Key](https://developers.onidel.com/api-reference/ssh-key/create-a-new-ssh-key.md): Add a new SSH key to the team
- [Delete SSH Key](https://developers.onidel.com/api-reference/ssh-key/delete-ssh-key.md): Delete an SSH key
- [Get SSH Key by ID](https://developers.onidel.com/api-reference/ssh-key/get-ssh-key-by-id.md): Retrieve a specific SSH key by its UUID
- [List SSH Keys](https://developers.onidel.com/api-reference/ssh-key/list-ssh-keys.md): Retrieve all SSH keys for a team
- [Update SSH Key](https://developers.onidel.com/api-reference/ssh-key/update-ssh-key.md): Update an existing SSH key
- [Create a new Startup Script](https://developers.onidel.com/api-reference/startup-script/create-a-new-startup-script.md): Add a new startup script to the team. Maximum 10 scripts per team.
- [Delete Startup Script](https://developers.onidel.com/api-reference/startup-script/delete-startup-script.md): Delete a startup script
- [Get Startup Script by ID](https://developers.onidel.com/api-reference/startup-script/get-startup-script-by-id.md): Retrieve a specific startup script by its UUID, including content
- [List Startup Scripts](https://developers.onidel.com/api-reference/startup-script/list-startup-scripts.md): Retrieve all startup scripts for a team
- [Update Startup Script](https://developers.onidel.com/api-reference/startup-script/update-startup-script.md): Update an existing startup script
- [List Teams](https://developers.onidel.com/api-reference/teams/list-teams.md): Retrieve all teams the user is a member of
- [Destroy the VM](https://developers.onidel.com/api-reference/virtual-machine/destroy-the-vm.md): Destroy the VM
- [Get a VM by UUID](https://developers.onidel.com/api-reference/virtual-machine/get-a-vm-by-uuid.md): Gets a VM by its UUID
- [Get all backups of the VM](https://developers.onidel.com/api-reference/virtual-machine/get-all-backups-of-the-vm.md): Get all backups of the VM
- [List VMs](https://developers.onidel.com/api-reference/virtual-machine/list-vms.md): List all VMs available to the user
- [Open a noVNC console session](https://developers.onidel.com/api-reference/virtual-machine/open-a-novnc-console-session.md): Creates a noVNC console session for the specified VM. Returns a URL to access the VM console via noVNC in a browser. The session token expires after 30 seconds if not used.
- [Perform an action on the VM](https://developers.onidel.com/api-reference/virtual-machine/perform-an-action-on-the-vm.md): Perform an action on the VM
- [Provision a new VM](https://developers.onidel.com/api-reference/virtual-machine/provision-a-new-vm.md): Provision a new VM
- [Update VM configuration](https://developers.onidel.com/api-reference/virtual-machine/update-vm-configuration.md): Update VM configuration
- [Create a new VPC](https://developers.onidel.com/api-reference/vpc/create-a-new-vpc.md): Create a new Virtual Private Cloud network
- [Delete VPC](https://developers.onidel.com/api-reference/vpc/delete-vpc.md): Delete a VPC (must not have any attached VMs)
- [Get VPC by ID](https://developers.onidel.com/api-reference/vpc/get-vpc-by-id.md): Retrieve a specific VPC by its UUID
- [List VPCs](https://developers.onidel.com/api-reference/vpc/list-vpcs.md): Retrieve all VPCs for a team
- [Update VPC](https://developers.onidel.com/api-reference/vpc/update-vpc.md): Update an existing VPC's name, description, or shared teams

## OpenAPI Specs

- [openapi](https://developers.onidel.com/api-reference/openapi.yaml)

## Optional

- [Knowledge Base](https://kb.onidel.com)
- [Website](https://onidel.com)
- [Control Panel](https://cloud.onidel.com)