hosting

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

Take a vendor restore point for a site.

ავტორიზაცია

API გასაღები გაგზავნეთ როგორც მატარებელი ტოკენი (bearer token). გასაღებს უნდა ჰქონდეს hosting.backup.manage ნებართვა; ამის გარეშე გასაღები უარყოფილი იქნება 403 და არა 404 სტატუსით.

ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.

სცადეთ

შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.

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 კონსოლი ავტომატურად ამატებს თქვენი რეალური ორგანიზაციის ID-სა და საკუთარ გასაღებს და ატარებს მოთხოვნას ცოცხალ API-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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