Publishing tools
Publish a draft, check versions or serve an earlier version again.
On this page
Note
The connection covers the Space. You are a member, and the Space is not locked. A Space is a shared workspace in the app.
hosting_list_deploys can be called with any role, including Read-only. The other four require Owner, Administrator or User; this also applies to hosting_deploy_status.
Warning
hosting_deploy completes exactly the project's draft and makes it live: anything absent from the draft is not part of the new version. A newly opened draft starts empty and is not a copy of the published version; see File tools. Without an index.html in the root folder, completion fails.
All tools on this page act on the first call without a confirmation sentence. The application is not guaranteed to ask first.
hosting_deploy Publish deployment
changes datadeletes, overwrites or changes what visitors see
Completes and publishes the draft. With deploy, it instead publishes a specific completed version; republishing does not count towards the plan limit.
The response gives the address and the access required for private websites. If file or storage limits are exceeded, the new version is discarded; older versions remain.
| Parameter | Type | Requirement | Description |
|---|---|---|---|
space | Integer | required | The ten-digit Space ID. |
project | Integer | required | The project number shown by hosting_list_projects. |
deploy | Integer | optional | The number of a completed version in this project. If omitted, the tool publishes the draft. |
hosting_deploy_status Deployment status
changes datadeletes, overwrites or changes what visitors see
Queries the given version's state; without a number, the draft, otherwise the published version.
The call saves the state in the app. When a version is completed, older versions may be permanently removed; if the new version does not fit within the plan, it is discarded instead.
| Parameter | Type | Requirement | Description |
|---|---|---|---|
space | Integer | required | The ten-digit Space ID. |
project | Integer | required | The project number shown by hosting_list_projects. |
deploy | Integer | optional | The number of a version in this project. If omitted, the tool uses the draft, otherwise the published version. |
hosting_list_deploys List deployments
reads only
Lists versions and the published version number for further calls with deploy.
The response gives state, size, backups, problems and plan usage.
| Parameter | Type | Requirement | Description |
|---|---|---|---|
space | Integer | required | The ten-digit Space ID. |
project | Integer | required | The project number shown by hosting_list_projects. |
hosting_rollback Roll back deployment
changes datadeletes, overwrites or changes what visitors see
Republishes an existing version that was published before. This uses no publication; the previously active version is retained.
If the version is already active, nothing changes. Visitors see the change once it is transferred to the hosting node.
| Parameter | Type | Requirement | Description |
|---|---|---|---|
space | Integer | required | The ten-digit Space ID. |
project | Integer | required | The project number shown by hosting_list_projects. |
deploy | Integer | required | The number of the version to roll back to. It must have been published before. |
hosting_set_offline Take project offline or online
changes datadeletes, overwrites or changes what visitors see
Takes a project's website offline or brings it online again. Going offline deletes nothing: versions, domains and settings remain.
While offline, visitors see an error page at every address; upload addresses are not issued. Changes take effect after transfer.
| Parameter | Type | Requirement | Description |
|---|---|---|---|
space | Integer | required | The ten-digit Space ID. |
project | Integer | required | The project number shown by hosting_list_projects. |
offline | Boolean | required | true takes the website offline, false brings it online again. |
The plan limits publications and versions
Free allows 3 publications in total and retains 3 versions plus 1 backup per project. Max has no limit on the number of publications and retains 5 versions plus 3 backups.
Warning
A newly completed version may permanently displace the oldest versions. The published version, draft and backups are protected.
Republishing does not count; when publications are used up, writing and uploading new files remain blocked. Details: Plan limits.
A backup is a completed version that is retained
Backups remain when new versions are added and do not count towards the versions normally retained. hosting_list_deploys and hosting_deploy_status show their backup status.
How do I set a backup?
No Connector tool sets or removes backup status. Do this in the app: in the version list on the project page, open a version's menu and choose Keep as backup or Unmark as backup. See Manage versions and backups.
A paused Space serves no websites
After a subscription ends, tools may keep working although visitors see no website. Free limits apply; the field offline only shows the individual project's switch.
hosting_create_upload receives no upload address. Switch the Space to Free in the app or subscribe again; no tool does this.
TEISENDA emails when storage is running low
Which email is sent when, and to whom?
TEISENDA checks about every five minutes whether usage triggers an email; the tool call itself does not send one. See Usage emails for thresholds, recipients and repeat notices.
If something goes wrong
Where a solution names a tool, ask the application to call it. If a message refers to Plans, follow the route to your plan in Space settings.
“This Space's plan allows … deployments; … have been used. Nothing was uploaded and no version was created. …”
hosting_deploy was called without a version number, and the Space's plan allows no further publication; Free allows three in total. TEISENDA uploaded and created nothing. Republishing a previously published version uses no publication and remains possible with hosting_rollback or with hosting_deploy and its number. Max offers more publications; see Free and Max plans.
“This Space's plan allows … deployments; … have been used. Version … is ready but not published. …”
hosting_deploy was called with the number of a ready version, one that has never been published, and the Space's plan allows no further publication. The version remains ready and is not published. Republishing a previously published version uses no publication and remains possible with hosting_rollback or with hosting_deploy and its number. Max offers more publications; see Free and Max plans.
“Version … is already published: …”
This is not a rejection: hosting_rollback or hosting_deploy was called with the number of the already published version. The tool says so and changes nothing. You need do nothing; to roll back, name another version.
There is no open version. First put files in with hosting_put_files.
The project has no draft that hosting_deploy can publish. First write files with hosting_put_files.
The project has no deployment yet.
hosting_deploy_status was called without a number, and the project has no version at all. First write files with hosting_put_files.
“Version … does not exist in this project.”
The project has no version with the number given in the argument deploy, for example because TEISENDA deleted it when the hosting node completed newer versions. Use hosting_list_deploys to check which versions remain.
“Version … has never been published. To publish it, use hosting_deploy.“
hosting_rollback was called for a version that has never been published. Publishing it would be a first publication and count towards the plan. Use hosting_deploy with its number, or name a previously published version.
The version isn't ready yet.
hosting_deploy was called with the number of an incomplete version; for the websites available today, that is the draft. With a number, the tool only publishes and completes nothing. For the draft, call hosting_deploy without a number to complete and publish it. The node completes a version uploaded in the app interface itself; check when with hosting_deploy_status.
The top-level folder is missing index.html.
The version has no index.html in its root folder. It therefore cannot be completed or published. Put an index.html in the root folder and publish again.
“Version … was not accepted and was discarded: …”
TEISENDA discarded the completed version; older versions are unchanged. The message gives one of three reasons:
- The version exceeds the plan's per-version size limit (“Its size is …, …”). Make the website smaller.
- It contains more files than the plan allows per version (“It contains … files, …”). Reduce the file count.
- With it, the Space would exceed its plan's storage limit (“It would use …, …”). Delete versions or backups in TEISENDA; Max and its packages provide more storage. See Buy and cancel additional packages.
Max has no separate per-version plan limit; see Free and Max plans. The storage-full message before uploading is listed under File tools.
Messages about the Space and project number are listed with the tools for Spaces and projects. All other messages that can occur with any tool are listed under Troubleshoot the Connector.