hosting

POST /v1/sites/{siteId}/redirects

Add a redirect to a site.

همه نقاط پایانی hosting

همهٔ مستندات توسعه‌دهندگان

احراز هویت

یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز sites.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد می‌شود، نه 404.

این نقطه پایانی هیچ شناسه سازمانی را دریافت نمی‌کند. کلید شما در حال حاضر سازمان مربوطه را مشخص می‌کند و پاسخ در همان محدوده ارائه می‌شود.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

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

وارد شده‌اید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی API زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید

جزئیات

Adds one rule. ⛔ The vendor endpoint behind this is a whole-set write, so the engine reads the existing rules, appends, and sends the set back — last writer wins. Two people adding a redirect at the same moment is the one case where one of the two additions is lost, and there is no vendor primitive that would prevent it. destination is checked before anything is written to the customer's .htaccess: a protocol-relative //evil.example/ passes a naive "starts with a slash" test and redirects the site's visitors to somebody else's server, so it is refused 422 here. type is a closed set (301, 302) checked in this layer and in the driver, because the platform types it as a free string and an unreviewed token would be written straight into the file. 404 for a site with no managed hosting package. Requires sites.view and sites.panel_access.

پارامترها

نامنوعالزامیچیست
siteId (path)UuidبلهSite ID (UUIDv7).

بدنه درخواست

نامنوعالزامیچیست
domainstringبلهThe domain or alias on the package the rule applies to.
pathstringبلهThe path being redirected. ⛔ Named path and never sourcesource is a reserved attribute on every serializer field one layer down, and a field of that name silently reads…
destinationstringبلهWhere the visitor is sent. A protocol-relative value is refused: it hands the customer's visitors to another server while looking like a local path.
typestring<301, 302>خیرThe redirect status. 301 is permanent and is cached by browsers and search engines; 302 is temporary. Nothing else is accepted.

پاسخ

نامنوعالزامیچیست
idstringبلهOurs, not the vendor's — this platform mints no identifier for a redirect, so this encodes the domain/type/path triple that addresses one. Opaque, stable across reads, and…
domainstringبلهThe domain or alias the rule applies to.
pathstringبلهThe path being redirected. ⛔ Named path and never source, which is a reserved attribute one layer down and would silently read the wrong value.
destinationstringبلهWhere the visitor is sent.
typestring<301, 302>بلهThe redirect status — permanent or temporary.

خطاهایی که این نقطه پایانی می‌تواند برگرداند

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