The Tilizy API
See where the public API stands and how to script Tilizy with the CLI until it exists.
On this page
This page says where the Tilizy API stands and what to use until it exists. In short: there is no public API yet, and the Tilizy CLI is the way to script Tilizy today.
Where the API stands
- A public API is not available yet.
- An API reference is listed as planned for this documentation. Its subject is how to read and change your data from your own tools.
- There is no date. The roadmap does not list the API among the work in progress or the work planned next.
When something ships, it appears in the changelog with its date.
Note: There is nothing to sign up for and no key to request. This page will be updated when that changes.
What to use today: the Tilizy CLI
The Tilizy CLI is one command-line tool for your websites on Tilizy. It is included in every Tilizy Hosting plan. Because it runs in a terminal, you can call it from your own scripts.
Its commands are grouped by what you are doing:
| Area | What the commands do |
|---|---|
| Environments | Start, deploy, roll back, read logs |
| Databases | Dump, load, synchronise and connect |
| Files | Inspect and transfer the files your application keeps |
| Variables and secrets | Manage environment variables and secrets |
| Domains | Manage domains and certificates |
| Backups | Create, inspect and restore backups |
| Requests | Create, read and manage project work |
| Time | Track and review time spent on project work |
| Framework commands | Run the commands of your framework through the same tool |
Every command explains itself. Add --help to a command to see its options.
Start here
- Install the CLI.
- Look up the command you need in the command reference.
Next: Install the CLI, or read How hosting works.