hosting

POST `/v1/sites/{siteId}/vendor-snapshots`

Take a vendor restore point for a site.

توثيقِ شناخت

ایک بیرر ٹوکن کے طور پر ایک API کی بھیجیں۔ کی کے پاس hosting.backup.manage اجازت ہونی چاہیے؛ اس کے بغیر کی کو 404 کے بجائے 403 کے ساتھ مسترد کر دیا جاتا ہے۔

یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔

آزمائیں

کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/vendor-snapshots \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "scope": <string<web, database, mailbox>> }'

لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو API کنسول میں کھولیں

تفصیلات

Asks the hosting platform to snapshot the website, one database or one mailbox. `202`, because the platform runs the job afterwards and a `200` would claim an instant we never observed. ⛔ **The response is the new state of the whole surface, never a bare acknowledgement.** The client writes it straight into its cache, so an empty body would leave the button un-flipped and the poll never started, with nothing failing anywhere. `item_id` is empty for the website, whose item the platform identifies for us, and is checked against the live listing rather than trusted. A scope the platform cannot back up, a package type that excludes the surface, or a job already running are all `422` with our wording. `404` for a site with no vendor hosting package, or one that is not the caller's. Requires `hosting.backup.manage`.

پیرامیٹرز

نام	قسم	لازمی	یہ کیا ہے
`siteId (path)`	`Uuid`	ہاں	Site ID (UUIDv7).

درخواست کا باڈی

نام	قسم	لازمی	یہ کیا ہے
`scope`	`string<web, database, mailbox>`	ہاں	What to snapshot.
`item_id`	`string`	نہیں	Which database or mailbox. Empty for the website, whose item the platform identifies for us. It is checked against the live listing rather than trusted, so an id a client compos…

جواب

نام	قسم	لازمی	یہ کیا ہے
`available`	`boolean`	ہاں	Whether the site's hosting platform has a timeline surface at all. False is our gap, and nothing the customer can do changes it.
`permitted`	`boolean`	ہاں	Whether the vendor package type includes it. False is answered by an upgrade.
`pro`	`boolean`	ہاں	Whether the package carries the paid tier rather than the included one.
`attached`	`boolean`	ہاں	Whether a Timeline Storage service is actually attached to the package. False is the third "no", and it is neither of the other two.
`can_back_up`	`boolean`	ہاں	Whether `takeSiteVendorSnapshot` would be accepted right now. Read rather than recomputed from the three flags above, so a screen never offers a button the engine refuses.
`has_dead_web`	`boolean`	ہاں	Whether the platform reports the website's timeline as broken. It is surfaced rather than hidden: a customer whose restore points stopped being taken needs to know before they n…
`in_progress`	`boolean`	ہاں	Whether any snapshot or restore job is running. This is what a client polls on, and only while it is true.
`web`	`SiteVendorSnapshotItem`	ہاں	The website's timeline, or null when the platform holds none.
`databases`	`SiteVendorSnapshotItem[]`	ہاں	Each database's timeline.
`mailboxes`	`SiteVendorSnapshotItem[]`	ہاں	Each mailbox's timeline.

وہ خرابیان جو یہ اینڈ پوائنٹ واپس کر سکتا ہے

401 · 403 · 404 · 422 · 429 · 503

POST /v1/sites/{siteId}/vendor-snapshots