# Liara OpenAPI Docs

## Docs

- [Backup a database](https://developers.liara.ir/dbass/backups/backup-a-database.md): backup a database that user owns
- [Download a backup](https://developers.liara.ir/dbass/backups/download-a-backup.md): download a backup that user owns
- [Get all backups](https://developers.liara.ir/dbass/backups/get-all-backups.md): get all backups that user owns
- [Change control-panel status](https://developers.liara.ir/dbass/databases/change-control-panel-status.md): change control-panel status that user owns
- [Change public network status](https://developers.liara.ir/dbass/databases/change-public-network-status.md): change public network status that user owns
- [Create a database](https://developers.liara.ir/dbass/databases/create-a-database.md): create a database that user owns
- [Delete a database](https://developers.liara.ir/dbass/databases/delete-a-database.md): delete a database that user owns
- [Get a database](https://developers.liara.ir/dbass/databases/get-a-database.md): get a database that user owns
- [Get all databases](https://developers.liara.ir/dbass/databases/get-all-databases.md): get all databases that user owns
- [Power on or power off a database](https://developers.liara.ir/dbass/databases/power-on-or-power-off-a-database.md): power on or power off a database that user owns
- [Resize a database](https://developers.liara.ir/dbass/databases/resize-a-database.md): resize a database that user owns
- [Settings a database](https://developers.liara.ir/dbass/databases/settings-a-database.md): settings a database that user owns
- [Get events of the database](https://developers.liara.ir/dbass/get-events-of-the-database.md): get events of the database owned by user
- [Get cpu reports of database](https://developers.liara.ir/dbass/reports/get-cpu-reports-of-database.md): get cpu reports of database that user owns
- [Get memory reports of database](https://developers.liara.ir/dbass/reports/get-memory-reports-of-database.md): get memory reports of database that user owns
- [Get network-receive reports of database](https://developers.liara.ir/dbass/reports/get-network-receive-reports-of-database.md): get network-receive reports of database that user owns
- [Get network-transmit reports of database](https://developers.liara.ir/dbass/reports/get-network-transmit-reports-of-database.md): get network-transmit reports of database that user owns
- [Get summary reports of database](https://developers.liara.ir/dbass/reports/get-summary-reports-of-database.md): get summary reports of database that user owns
- [check nameserver](https://developers.liara.ir/dns/check-name-servers/check-nameserver.md): check nameserver of zone
- [Create dns record](https://developers.liara.ir/dns/dns-record/create-dns-record.md): Creates a new dns record, returns the dns record on creation
- [delete dns record](https://developers.liara.ir/dns/dns-record/delete-dns-record.md): Delete dns record from this zone
- [edit dns record](https://developers.liara.ir/dns/dns-record/edit-dns-record.md): you can not edit type of dns record
- [Get all dns record](https://developers.liara.ir/dns/dns-record/get-all-dns-record.md): Get all Dns Records on this zone
- [Get dns record](https://developers.liara.ir/dns/dns-record/get-dns-record.md): Get Dns Record data on this zone
- [Create Zone](https://developers.liara.ir/dns/zone/create-zone.md): creates a new zone on dns server
- [Delete Zone](https://developers.liara.ir/dns/zone/delete-zone.md): Deletes this zone, all dns records
- [Get Zone](https://developers.liara.ir/dns/zone/get-zone.md): Get this zone, all dns records
- [List all zones](https://developers.liara.ir/dns/zone/list-all-zones.md): list all zones that user owns
- [Create file or dir in FileBrowser](https://developers.liara.ir/file-browser/disks/create-file-or-dir-in-filebrowser.md)
- [Create link for file in FileBrowser](https://developers.liara.ir/file-browser/disks/create-link-for-file-in-filebrowser.md)
- [Delete file or dir in FileBrowser](https://developers.liara.ir/file-browser/disks/delete-file-or-dir-in-filebrowser.md)
- [Extract file in FileBrowser](https://developers.liara.ir/file-browser/disks/extract-file-in-filebrowser.md)
- [Get list from FileBrowser](https://developers.liara.ir/file-browser/disks/get-list-from-filebrowser.md)
- [Rename file or dir in FileBrowser](https://developers.liara.ir/file-browser/disks/rename-file-or-dir-in-filebrowser.md)
- [Search file or dir in FileBrowser](https://developers.liara.ir/file-browser/disks/search-file-or-dir-in-filebrowser.md)
- [Serve file from FileBrowser](https://developers.liara.ir/file-browser/disks/serve-file-from-filebrowser.md)
- [Upload file in FileBrowser](https://developers.liara.ir/file-browser/disks/upload-file-in-filebrowser.md)
- [Create a new disk for a VM](https://developers.liara.ir/iaas/vms/create-a-new-disk-for-a-vm.md): create a disk for a vm that user owns
- [Create a vm](https://developers.liara.ir/iaas/vms/create-a-vm.md): create a vm that user owns
- [Delete a disk](https://developers.liara.ir/iaas/vms/delete-a-disk.md): Delete a disk of a vm that user owns
- [Delete a vm](https://developers.liara.ir/iaas/vms/delete-a-vm.md): delete a vm that user owns
- [Extend a vm Disk](https://developers.liara.ir/iaas/vms/extend-a-vm-disk.md): extend a vm that user owns
- [Get all available operating systems](https://developers.liara.ir/iaas/vms/get-all-available-operating-systems.md): get all available operating systems
- [Get all plans](https://developers.liara.ir/iaas/vms/get-all-plans.md): get all Iaas plans
- [Get all vms](https://developers.liara.ir/iaas/vms/get-all-vms.md): get all vms that user owns
- [Get disk details](https://developers.liara.ir/iaas/vms/get-disk-details.md): get disk details of a vm that user owns
- [Get traffic graph of a vm](https://developers.liara.ir/iaas/vms/get-traffic-graph-of-a-vm.md): get traffic graph of a vm that user owns
- [Get traffic volume of a vm](https://developers.liara.ir/iaas/vms/get-traffic-volume-of-a-vm.md): get traffic volume of a vm that user owns
- [Get vm details](https://developers.liara.ir/iaas/vms/get-vm-details.md): get a vm that user owns
- [Get vm operations](https://developers.liara.ir/iaas/vms/get-vm-operations.md): get operations of a vm that user owns
- [Reset a vm network](https://developers.liara.ir/iaas/vms/reset-a-vm-network.md): reset network a vm that user owns
- [Reset a vm password](https://developers.liara.ir/iaas/vms/reset-a-vm-password.md): reset password of a vm that user owns
- [Resize a vm](https://developers.liara.ir/iaas/vms/resize-a-vm.md): resize a vm that user owns
- [Set vm power](https://developers.liara.ir/iaas/vms/set-vm-power.md): set power of a vm that user owns
- [Unfreeze a vm](https://developers.liara.ir/iaas/vms/unfreeze-a-vm.md): unfreeze a vm that user owns
- [add mail account](https://developers.liara.ir/mail/accounts/add-mail-account.md)
- [check if mail account is available](https://developers.liara.ir/mail/accounts/check-if-mail-account-is-available.md)
- [delete mail account](https://developers.liara.ir/mail/accounts/delete-mail-account.md)
- [get all mail accounts](https://developers.liara.ir/mail/accounts/get-all-mail-accounts.md)
- [download attachment](https://developers.liara.ir/mail/attachments/download-attachment.md)
- [get all attachments for message](https://developers.liara.ir/mail/attachments/get-all-attachments-for-message.md)
- [get all events for message](https://developers.liara.ir/mail/event/get-all-events-for-message.md)
- [add address endpoint to forwarding mails](https://developers.liara.ir/mail/forward/add-address-endpoint-to-forwarding-mails.md)
- [delete extra endpoint address](https://developers.liara.ir/mail/forward/delete-extra-endpoint-address.md)
- [get all extra address to forwarding mails](https://developers.liara.ir/mail/forward/get-all-extra-address-to-forwarding-mails.md)
- [add inbound rule.](https://developers.liara.ir/mail/inboundrules/add-inbound-rule.md)
- [delete inbound rule.](https://developers.liara.ir/mail/inboundrules/delete-inbound-rule.md)
- [get all inbound rules.](https://developers.liara.ir/mail/inboundrules/get-all-inbound-rules.md)
- [check if domain name is available](https://developers.liara.ir/mail/mails/check-if-domain-name-is-available.md)
- [count number of sent mails every day](https://developers.liara.ir/mail/mails/count-number-of-sent-mails-every-day.md)
- [create mail server](https://developers.liara.ir/mail/mails/create-mail-server.md)
- [delete mail server](https://developers.liara.ir/mail/mails/delete-mail-server.md)
- [edit mail server](https://developers.liara.ir/mail/mails/edit-mail-server.md)
- [gain more info on recent usage](https://developers.liara.ir/mail/mails/gain-more-info-on-recent-usage.md)
- [get all mail servers](https://developers.liara.ir/mail/mails/get-all-mail-servers.md)
- [get single mail server](https://developers.liara.ir/mail/mails/get-single-mail-server.md)
- [mail server check dns status](https://developers.liara.ir/mail/mails/mail-server-check-dns-status.md)
- [unfreeze mail server - If you had reserved a plan, it will be your new plan.](https://developers.liara.ir/mail/mails/unfreeze-mail-server--if-you-had-reserved-a-plan-it-will-be-your-new-plan.md)
- [delete a message permenantly](https://developers.liara.ir/mail/messages/delete-a-message-permenantly.md)
- [generate temporary access to email html](https://developers.liara.ir/mail/messages/generate-temporary-access-to-email-html.md)
- [get all mails](https://developers.liara.ir/mail/messages/get-all-mails.md)
- [get single mail](https://developers.liara.ir/mail/messages/get-single-mail.md)
- [get single mail html](https://developers.liara.ir/mail/messages/get-single-mail-html.md)
- [send a mail](https://developers.liara.ir/mail/messages/send-a-mail.md)
- [trash and untrash a message](https://developers.liara.ir/mail/messages/trash-and-untrash-a-message.md)
- [change mail server plan](https://developers.liara.ir/mail/plan/change-mail-server-plan.md): Upgrades take effect immediately, while downgrades are scheduled and applied after the current plan ends. Click on the request body schema to see all available plans.
- [get cuurent mail server plan history](https://developers.liara.ir/mail/plan/get-cuurent-mail-server-plan-history.md)
- [remove a reserved plan](https://developers.liara.ir/mail/plan/remove-a-reserved-plan.md): Click on the request body schema to see all available plans.
- [delete smtp credential](https://developers.liara.ir/mail/smtp/delete-smtp-credential.md)
- [generate credentials to connet mail server with SMTP](https://developers.liara.ir/mail/smtp/generate-credentials-to-connet-mail-server-with-smtp.md)
- [get credential to connect to mail server with SMTP](https://developers.liara.ir/mail/smtp/get-credential-to-connect-to-mail-server-with-smtp.md)
- [revoke credentials to connect mail server with SMTP](https://developers.liara.ir/mail/smtp/revoke-credentials-to-connect-mail-server-with-smtp.md)
- [create a new tag](https://developers.liara.ir/mail/tags/create-a-new-tag.md)
- [get all tags](https://developers.liara.ir/mail/tags/get-all-tags.md)
- [get all tags](https://developers.liara.ir/mail/tags/get-all-tags-1.md)
- [change Bucket Access Policy](https://developers.liara.ir/object-storage/bucket/change-bucket-access-policy.md): Change Bucket Access policy on an object storage ( public / private )
- [Check Bucket availability](https://developers.liara.ir/object-storage/bucket/check-bucket-availability.md): Check if you can create Bucket with specified Name.
- [Create Bucket](https://developers.liara.ir/object-storage/bucket/create-bucket.md): creates a new bucket on an object storage
- [Destroy Bucket](https://developers.liara.ir/object-storage/bucket/destroy-bucket.md): Delete Bucket on an object storage
- [Get Single Buckets](https://developers.liara.ir/object-storage/bucket/get-single-buckets.md)
- [List all Buckets](https://developers.liara.ir/object-storage/bucket/list-all-buckets.md): List all Bucket
- [list migration operation](https://developers.liara.ir/object-storage/bucket/list-migration-operation.md): list migration operation
- [List storage service buckets](https://developers.liara.ir/object-storage/bucket/list-storage-service-buckets.md): List previous buckets of storage service in liara.
- [Migrating buckets](https://developers.liara.ir/object-storage/bucket/migrating-buckets.md): Move data from one bucket to another
- [Upgrade Bucket](https://developers.liara.ir/object-storage/bucket/upgrade-bucket.md): Upgrade Bucket plan ( just make space bigger )
- [Create Folder](https://developers.liara.ir/object-storage/folder/create-folder.md): Create Folder in Bucket
- [Delete Folder](https://developers.liara.ir/object-storage/folder/delete-folder.md): Delete Folder in Bucket
- [Create Keys](https://developers.liara.ir/object-storage/key/create-keys.md): Create access and secret key
- [Delete Key](https://developers.liara.ir/object-storage/key/delete-key.md): Delete access key
- [Get Key](https://developers.liara.ir/object-storage/key/get-key.md): Get a key
- [Get List of Keys](https://developers.liara.ir/object-storage/key/get-list-of-keys.md)
- [Revoke secret key](https://developers.liara.ir/object-storage/key/revoke-secret-key.md): Revoke secret key
- [Update key](https://developers.liara.ir/object-storage/key/update-key.md): Update buckets of key ( redefine )
- [get statistic](https://developers.liara.ir/object-storage/metrics/get-statistic.md)
- [hisotrical metrics](https://developers.liara.ir/object-storage/metrics/hisotrical-metrics.md)
- [metrics summary](https://developers.liara.ir/object-storage/metrics/metrics-summary.md)
- [Delete Object](https://developers.liara.ir/object-storage/object/delete-object.md): Delete an object from storage
- [Download Object](https://developers.liara.ir/object-storage/object/download-object.md): Return presigned url for download object
- [Get Stat Object](https://developers.liara.ir/object-storage/object/get-stat-object.md)
- [List Objects](https://developers.liara.ir/object-storage/object/list-objects.md): Return list of objects ( max:50, min:1 )
- [Upload Object](https://developers.liara.ir/object-storage/object/upload-object.md): Return presigned url for download object
- [DBaaS API](https://developers.liara.ir/pages/dbaas.md): Database as a Service API for managing cloud databases
- [DNS API](https://developers.liara.ir/pages/dns.md): DNS management API for zones and records
- [File Browser API](https://developers.liara.ir/pages/file-browser.md): File management API for disks attached to your applications
- [IaaS API](https://developers.liara.ir/pages/iaas.md): Infrastructure as a Service API for managing virtual machines
- [Mail API](https://developers.liara.ir/pages/mail.md): Email delivery platform for incoming and outgoing mail
- [Object Storage API](https://developers.liara.ir/pages/object-storage.md): Scalable object storage solution for storing and managing data
- [PaaS API](https://developers.liara.ir/pages/paas.md): Platform as a Service API for deploying and managing applications
- [Change plan](https://developers.liara.ir/pass/apps/change-plan.md): create app that user owns
- [Create a app](https://developers.liara.ir/pass/apps/create-a-app.md): create app that user owns
- [Delete a app](https://developers.liara.ir/pass/apps/delete-a-app.md): delete app that user owns
- [Get applets of app](https://developers.liara.ir/pass/apps/get-applets-of-app.md): get applets of app that user owns
- [Get details of a project](https://developers.liara.ir/pass/apps/get-details-of-a-project.md): get all details of all project that user owns
- [Get details of all projects](https://developers.liara.ir/pass/apps/get-details-of-all-projects.md): get all details of all projects that user owns
- [Get events of the app](https://developers.liara.ir/pass/apps/get-events-of-the-app.md): get events of the app owned by user
- [Get logs of app](https://developers.liara.ir/pass/apps/get-logs-of-app.md): get logs of app that user owns
- [Get releases of app](https://developers.liara.ir/pass/apps/get-releases-of-app.md): get releases of app that user owns
- [To restart a app](https://developers.liara.ir/pass/apps/to-restart-a-app.md): to restart app that user owns
- [Turn on or off a app](https://developers.liara.ir/pass/apps/turn-on-or-off-a-app.md): turn on or off a app that user owns
- [Deploy releases](https://developers.liara.ir/pass/deploy/deploy-releases.md): deploy releases that user owns
- [Deploy sources code](https://developers.liara.ir/pass/deploy/deploy-sources-code.md): deploy sources code that user owns
- [Create a disk](https://developers.liara.ir/pass/disks/create-a-disk.md): create a disk that user owns
- [Create backup disk](https://developers.liara.ir/pass/disks/create-backup-disk.md): create backup disk that user owns
- [Create ftp](https://developers.liara.ir/pass/disks/create-ftp.md): create ftp that user owns
- [Delete a disk](https://developers.liara.ir/pass/disks/delete-a-disk.md): delete a disk that user owns
- [Delete a ftp](https://developers.liara.ir/pass/disks/delete-a-ftp.md): delete a ftp that user owns
- [Download backup disk](https://developers.liara.ir/pass/disks/download-backup-disk.md): download backup disk that user owns
- [Get backups disk](https://developers.liara.ir/pass/disks/get-backups-disk.md): get backups disk that user owns
- [Get disks](https://developers.liara.ir/pass/disks/get-disks.md): get disks that user owns
- [Get ftps](https://developers.liara.ir/pass/disks/get-ftps.md): get ftps that user owns
- [Resize disk](https://developers.liara.ir/pass/disks/resize-disk.md): resize disk that user owns
- [Check a domain](https://developers.liara.ir/pass/domains/check-a-domain.md): check a domain that user owns
- [Create a domain](https://developers.liara.ir/pass/domains/create-a-domain.md): create a domain that user owns
- [Delete a domain](https://developers.liara.ir/pass/domains/delete-a-domain.md): delete a domain that user owns
- [Disable ssl](https://developers.liara.ir/pass/domains/disable-ssl.md): disable ssl that user owns
- [Enable ssl](https://developers.liara.ir/pass/domains/enable-ssl.md): enable ssl that user owns
- [Get all domains](https://developers.liara.ir/pass/domains/get-all-domains.md): get all domains that user owns
- [Redirect a domain](https://developers.liara.ir/pass/domains/redirect-a-domain.md): redirect a domain that user owns
- [Set a domain for project](https://developers.liara.ir/pass/domains/set-a-domain-for-project.md): set a domain for project that user owns
- [Get cpu reports of app](https://developers.liara.ir/pass/reports/get-cpu-reports-of-app.md): get cpu reports of app that user owns
- [Get memory reports of app](https://developers.liara.ir/pass/reports/get-memory-reports-of-app.md): get memory reports of app that user owns
- [Get network-receive reports of app](https://developers.liara.ir/pass/reports/get-network-receive-reports-of-app.md): get network-receive reports of app that user owns
- [Get network-transmit reports of app](https://developers.liara.ir/pass/reports/get-network-transmit-reports-of-app.md): get network-transmit reports of app that user owns
- [Get summary reports of app](https://developers.liara.ir/pass/reports/get-summary-reports-of-app.md): get summary reports of app that user owns
- [Default subdomain](https://developers.liara.ir/pass/settings/default-subdomain.md): default subdomain that user owns
- [IP static](https://developers.liara.ir/pass/settings/ip-static.md): ip static that user owns
- [Read only](https://developers.liara.ir/pass/settings/read-only.md): read only that user owns
- [Update envs](https://developers.liara.ir/pass/settings/update-envs.md): update envs that user owns
- [Zero downtime](https://developers.liara.ir/pass/settings/zero-downtime.md): zero downtime that user owns

## OpenAPI Specs

- [paas](https://developers.liara.ir/spec/paas.yaml)
- [object-storage](https://developers.liara.ir/spec/object-storage.yaml)
- [mail](https://developers.liara.ir/spec/mail.yaml)
- [file-browser](https://developers.liara.ir/spec/file-browser.yaml)
- [dns](https://developers.liara.ir/spec/dns.yaml)
- [dbaas](https://developers.liara.ir/spec/dbaas.yaml)
- [database-inspector](https://developers.liara.ir/spec/database-inspector.yaml)
- [Iaas](https://developers.liara.ir/spec/Iaas.yaml)
- [openapi](https://developers.liara.ir/api-reference/openapi.json)

## Optional

- [Documentation](https://docs.liara.ir)
- [Blog](https://liara.ir/blog)