hosting

POST `/v1/sites/{siteId}/ftp-users`

Create an FTP account on a site.

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 sites.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/ftp-users \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "username": <string>, "password": <string> }'

已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。在 API 控制台中打开此端点

详细信息

Adds an account confined to one directory of the package. The **caller chooses the password** and it travels in the request only: it is never echoed in the response, never written to our records and never logged. That is the opposite of `createSiteDatabase`, and deliberately so — an FTP password is a long-lived credential a deployment pipeline will hold, so the person who owns that pipeline supplies it. The effective ceiling is applied **before** the vendor is called: a package type that does not permit extra accounts, and a customer who has used the last of their allowance, are both refused `422` with a sentence they can act on. A username the package already carries is refused `409` — the vendor namespaces usernames per package, so this collides with the customer's own accounts, not with anyone else's. `404` for a site with no vendor hosting package. Requires `sites.manage`.

参数

名称	类型	必填	内容简介
`siteId (path)`	`Uuid`	是	Site ID (UUIDv7).

请求正文

名称	类型	必填	内容简介
`username`	`string`	是	The login name to create. The vendor prefixes it per package on some package types, so the value that comes back in `SiteFtpUser.username` is the one that signs in — the client…
`password`	`string`	是	The account's password. Write-only: it is accepted here and appears in no response, no log line and no error body.
`path`	`string`	否	The directory the account is confined to, relative to the package root. Defaults to the whole site; narrowing it is how a deployment credential stops being a credential for ever…

响应

名称	类型	必填	内容简介
`id`	`string`	是	The account's identifier at the vendor, used to delete it.
`username`	`string`	是	The name that signs in. The vendor namespaces it per package on some package types, so this — not what was requested — is what the client shows.
`path`	`string`	是	The directory the account is confined to, relative to the package root. `/` is the whole site.
`enabled`	`boolean`	是	Whether the account may currently sign in.
`is_primary`	`boolean`	是	Whether this is the package's own built-in account. It is listed so the customer can see it exists, and it can never be deleted here — removing it takes the package's own access…

此端点可能返回的错误

401 · 403 · 404 · 409 · 422 · 429 · 503

POST /v1/sites/{siteId}/ftp-users