hosting

GET /v1/sites/{siteId}/wp-credentials

The WordPress admin login for a site.

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

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

احراز هویت

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

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

امتحان کنید

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

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/wp-credentials \
  -H "Authorization: Bearer zdk_live_…"

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

جزئیات

Requires sites.view and sites.panel_access — the key that already means "a customer reaching their own site". Every read is audit-logged: a password revealed by session alone is only safe if looking at it is attributable. Re-reads the site's own wp_users row before answering, so the screen a human is looking at is never stale. A site that cannot be reached is not an error: the stored record is returned unchanged and checked_at says when the platform last managed to look.

پارامترها

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

پاسخ

نامنوعالزامیچیست
site_idUuidبلهUUIDv7 identifier — sortable by creation time (docs/02 §8).
usernamestringبلهThis site's own admin username, re-read from the site's wp_users row on every request. A customer who renames the account in phpMyAdmin, wp-admin or wp-cli sees the new name…
emailstringبلهwp_users.user_email on the site itself — where a WordPress password reset would actually go. Empty until the platform has managed to read one.
passwordstringبلهThe current password, or empty when it cannot be shown — see can_reveal. It is derived from a platform key and the site's rotation epoch, never stored, so there is no per-site…
can_revealbooleanبلهFalse when the customer set their own password (nothing of ours to show) or the environment has no signing key. Rotating makes it true again.
is_custombooleanبلهThe password in use was set by the customer through this app, so there is nothing of ours to show. Distinct from changed_outside_app.
changed_outside_appbooleanبلهProven: the password the platform holds no longer opens the site, so it was changed outside of the Zinn Digital® Hosting App — phpMyAdmin, wp-admin or wp-cli. WordPress stores…
checked_atstringبلهWhen the platform last managed to LOOK at the site's admin row. Null means never.
verified_atstringبلهWhen the platform last PROVED these credentials are the live ones. Null means never. Deliberately separate from checked_at: "we have not been able to reach this site for a week"…
login_urlstringبلهWhere to sign in.

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

401 · 403 · 404 · 422 · 429