hosting

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

Take a vendor restore point for a site.

प्रमाणीकरण

बेरर टोकन म्हणून API की पाठवा. की मध्ये hosting.backup.manage परवानगी असणे आवश्यक आहे; ती नसलेली की 404 ऐवजी 403 सह नाकारली जाते.

या एंडपॉइंटला कोणतीही संस्था आयडी (organisation id) लागत नाही. तुमची की (key) आधीच ती कोणत्या संस्थेशी संबंधित आहे हे ओळखते आणि प्रतिसाद त्यानुसार मर्यादित केला जातो.

प्रयत्न करा

कोनसांस्कृतिक कंसात (<>) असलेली कोणतीही गोष्ट तुमच्या स्वतःच्या मूल्यांनी बदला आणि key प्लेसहोल्डरला तुमच्या डॅशबोर्डवरील किने बदला.

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 विरुद्ध विनंती कार्यान्वित करतो जेणेकरून तुम्हाला वास्तविक प्रतिसाद पाहता येईल. एपी कन्सोलमध्ये हा एंडपॉइंट उघडा

तपशील

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