Project tools
These tools read, create, rename and delete hosting projects in your Space. A Space is a shared workspace in the app.
On this page
Note
The connection covers the Space. You are a member, and the Space is not locked.
hosting_list_projects and hosting_project_status can be called with any role, including Read-only. The other three require Owner, Administrator or User.
hosting_list_projects List projects
reads only
Lists projects with their address, visibility and published version. Use the project number from this list as project.
Under deployments the response also gives the Space's used publications and how many its plan still allows; see the values under Publishing tools.
| Parameter | Type | Requirement | Description |
|---|---|---|---|
space | Integer | required | The ten-digit Space ID. |
hosting_project_status Project status
reads only
Shows address, visibility, versions, domains and transfer state. The rules themselves are read by hosting_list_redirects.
Use it to check the state after an aborted call or a pending transfer.
- It shows a custom domain's state as last saved by TEISENDA; for a pending domain, this may be about five minutes old. Only
hosting_check_domainqueries the hosting node at the time of the call. - In a Space TEISENDA paused after a subscription ended, it does not say that visitors receive an error page; see Tools keep working in a paused Space.
| Parameter | Type | Requirement | Description |
|---|---|---|---|
space | Integer | required | The ten-digit Space ID. |
project | Integer | required | The project number shown by hosting_list_projects. |
hosting_create_project Create project
changes data
Creates a private project with its own number and address. Initially, only the person creating it has access; then you can write files and publish.
- The plan limits a Space's projects: 1 on Free, 10 on Max. At the limit, TEISENDA rejects the call and creates nothing.
- A subscribed Max plan offers packages with 5 extra projects each; see Buy and cancel additional packages. For the plans, see Free and Max plans.
When does TEISENDA email that all websites in the plan are in use?
If the new project uses up the plan's project allowance, TEISENDA sends an email with the subject “… uses all websites in its plan”; the ellipsis is replaced by the Space. TEISENDA only sends it on a plan that allows more than one project.
It goes to the invoice email address in the Space's billing details. If none is saved, it goes to members with the Owner role, at most ten, each in their own language. The call itself sends nothing: TEISENDA checks about every five minutes whether this email is due.
| Parameter | Type | Requirement | Description |
|---|---|---|---|
space | Integer | required | The ten-digit Space ID. |
name | Text | required | A name for people, 1 to 80 characters, without control characters. The address does not depend on it. |
hosting_rename_project Rename project
changes data
Renames a project. The address stays the same.
| Parameter | Type | Requirement | Description |
|---|---|---|---|
space | Integer | required | The ten-digit Space ID. |
project | Integer | required | The project number shown by hosting_list_projects. |
name | Text | required | The project's new name: 1 to 80 characters, no control characters. |
hosting_delete_project Delete project
changes datadeletes, overwrites or changes what visitors seetwo steps
Deletes a project with all its versions, including backups, and its custom domains. The publications it used remain counted for the Space.
Warning
Deletion cannot be undone. The tool works in two steps: the first call, without confirm, deletes nothing and returns the confirmation sentence delete project <Nummer> in <Anzeigename des Space>. Only a second call sending this exact sentence as confirm deletes the project.
The application should first tell you what will happen and send the sentence only after you agree; see Three tools require a confirmation sentence.
| Parameter | Type | Requirement | Description |
|---|---|---|---|
space | Integer | required | The ten-digit Space ID. |
project | Integer | required | The project number shown by hosting_list_projects. |
confirm | Text | optional | The application should omit it on the first call; the response then gives a confirmation sentence. It should send this exact sentence only after you agree. |
If something goes wrong
Where a solution names a tool, ask the application to call it. Plan messages end with “This Space's plan is shown in TEISENDA under Settings › Plans.”; the settings entry is called Billing.
The project number is missing in the argument project. hosting_list_projects shows the numbers.
The argument project is missing or is not a project number. This affects every hosting tool that requires project. Check the numbers with hosting_list_projects.
“Project … does not exist in this Space.”
There is no project with this number in the named Space. Check the number with hosting_list_projects and check whether the Space is the one you intended.
“This Space's plan does not allow more projects: … of … have been created. Nothing was created. …”
The Space's plan does not allow another project: 1 on Free, 10 on Max, plus projects from packages. TEISENDA created nothing. Delete a project. Max and its packages allow more projects; see Free and Max plans and Buy and cancel additional packages.
“Project … (number …) is deleted. It is still being removed from the hosting node.”
This is not a rejection: hosting_delete_project deleted the project in TEISENDA, but the hosting node has not confirmed deletion. The website may still respond briefly. You do not need to do anything: TEISENDA retries deletion on the node automatically about every five minutes.
Space messages are listed under the Space tool. All other messages that can occur with any tool are listed under Troubleshoot the Connector.