POST /storage_boxes/{id}/subaccounts
Creates a new Subaccount with a separate home directory.
Servers
- https://api.hetzner.com/v1
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
Integer | Yes |
ID of the Storage Box. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
description |
String | No |
A description to remind you of the purpose of this Subaccount. |
labels |
Object | No |
The Subaccounts' labels. |
password |
String | Yes |
New password. |
home_directory |
String | Yes |
Home directory of the Subaccount. Will be created if it doesn't exist yet. |
access_settings |
Object | No | |
access_settings.readonly |
Boolean | No |
Whether the Subaccount should be read-only. |
access_settings.samba_enabled |
Boolean | No |
Whether the Samba subsystem should be enabled. |
access_settings.webdav_enabled |
Boolean | No |
Whether the WebDAV subsystem should be enabled. |
access_settings.reachable_externally |
Boolean | No |
Whether the Subaccount should be accessible from outside the Hetzner network. |
access_settings.ssh_enabled |
Boolean | No |
Whether the SSH subsystem should be enabled. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.