Connector tools
Find the right tool and its parameters. Each hosting tool works in one Space.
On this page
Note
The application is connected to your TEISENDA account, and the connection has not ended; see Claude and ChatGPT.
For a hosting tool, the connection covers the Space named in the call. You are a member there, and it is not locked.
Your Space role allows the tool.
The space argument determines the Space
Each hosting tool requires the argument space: the ten-digit Space ID. whoami takes no arguments.
The application should choose the Space from whoami or from you and ask if several Spaces could apply.
TEISENDA checks on every call whether the Space belongs to the connection and you are a member. The tool only runs in this one Space.
Which values does space accept?
A ten-digit integer or text containing exactly ten digits. TEISENDA responds to anything else as a missing Space, such as a number with fewer or more digits. For ten digits that do not identify a Space in the connection, TEISENDA says that the Space does not belong to the connection. Both messages are listed under the Space tool.
A hosting tool's result names the Space first
The result first gives the Space ID and display name. Check them; if the Space is wrong, the instructions tell the application to stop.
With Saved, but not yet transferred to the hosting node:, the change is saved but not transferred yet. Later, use hosting_project_status to check the state.
When is a result not an error even though something is pending?
Some results are not marked as errors: the tool did what it could and explains what is missing. This applies when the named version is already published, a domain's DNS is not correct yet, a project is deleted but the hosting node has not confirmed it, or a two-step tool's response asks for the confirmation sentence.
What does a tool change in TEISENDA, and where can I see it?
Each tool calls the same services as the app interface, with the same permissions and limits. A tool changes TEISENDA just as if you had made the change in the interface.
The project log records changes with the Connected app channel where the action creates an entry. Reading tools do not create entries there. When writing or deleting files, it only records that a new draft was opened.
Your role allows the tool
Owner, Administrator and User can call all hosting tools. Read-only can only use five reading hosting tools; see the list under Permissions.
The tool list also shows tools your role does not allow. Permission is checked when called.
No hosting tool works in a locked Space
whoami still lists a locked Space and marks it as locked, but no hosting tool works there. A connection with only locked Spaces offers the application only whoami. See the solution under the Space tool; for more about locks, see Understand Spaces.
Badges show whether a tool only reads or makes changes
The badges appear beside each tool and in the list below.
| Badge | Meaning |
|---|---|
| “reads only” | The tool changes nothing, creates no log entry visible in the app and can be repeated without effects. This applies to seven hosting tools and whoami. |
| “changes data” | The tool changes something. This applies to the other 16 hosting tools. |
| “deletes, overwrites or changes what visitors see” | The tool deletes, overwrites or changes what website visitors see. This badge does not mean a tool deletes; its section explains what it does. |
| “two steps” | The tool requires a confirmation sentence. |
Three tools require a confirmation sentence
hosting_delete_project, hosting_remove_domain and switching to public with hosting_set_visibility work in two steps: without confirm, the response gives the consequence and sentence; only a call with that sentence performs the action.
The application should first ask for your agreement. Check the project and Space; Permissions explains the process.
Warning
All other tools act on the first call, including deleting, overwriting or changing the website. The application is not guaranteed to ask first.
The tools use some different terms from these docs
The tools have English descriptions. Their German responses use some terms differently from these docs.
| In German responses | In these docs |
|---|---|
“Stand”, “Deployment”; as a parameter, deploy |
Version. The tools also use this for the draft. |
“Deployment” when counted towards a plan; as a field, deployments |
Publication: publishing a version for the first time uses one. Republishing a previously published version does not. |
| “offener Stand” | Draft: its files can still be changed, and it is not published. A project has at most one. |
| “abgeschlossen” | Completed version: any checked version that can no longer be changed, whether published or not. |
| “fertig, aber nicht veröffentlicht” | Ready version: a completed version that has never been published. |
| “automatic address” in tool descriptions | TEISENDA address: the address TEISENDA assigns to the project. |
Each tool has a section on a subpage
The name links to the tool's section with its parameters. Titles are in English.
| Tool | Title | Properties |
|---|---|---|
whoami | Show user and spaces | reads only |
hosting_list_projects | List projects | reads only |
hosting_create_project | Create project | changes data |
hosting_project_status | Project status | reads only |
hosting_rename_project | Rename project | changes data |
hosting_set_offline | Take project offline or online | changes datadeletes, overwrites or changes what visitors see |
hosting_delete_project | Delete project | changes datadeletes, overwrites or changes what visitors seetwo steps |
hosting_put_files | Write files | changes datadeletes, overwrites or changes what visitors see |
hosting_delete_files | Delete files | changes datadeletes, overwrites or changes what visitors see |
hosting_list_files | List files | reads only |
hosting_read_file | Read file | reads only |
hosting_create_upload | Create upload link | changes datadeletes, overwrites or changes what visitors see |
hosting_deploy | Publish deployment | changes datadeletes, overwrites or changes what visitors see |
hosting_deploy_status | Deployment status | changes datadeletes, overwrites or changes what visitors see |
hosting_list_deploys | List deployments | reads only |
hosting_rollback | Roll back deployment | changes datadeletes, overwrites or changes what visitors see |
hosting_add_domain | Add domain | changes data |
hosting_check_domain | Check domain | changes data |
hosting_set_primary_domain | Set primary domain | changes datadeletes, overwrites or changes what visitors see |
hosting_remove_domain | Remove domain | changes datadeletes, overwrites or changes what visitors seetwo steps |
hosting_get_visibility | Get visibility | reads only |
hosting_set_visibility | Set visibility | changes datadeletes, overwrites or changes what visitors seetwo steps |
hosting_list_redirects | List redirects | reads only |
hosting_set_redirects | Set redirects | changes datadeletes, overwrites or changes what visitors see |
Some limits and messages apply to every call
A call takes at most two minutes; a request is at most 8 MB. Additional limits and the troubleshooting guide apply to all tools.
Space plan limits are explained with the tools for projects, domains, files and publishing; for the plans, see Free and Max plans.