compute
POST /v1/compute/servers/{serverId}/services/action
Start, stop or restart one service inside a server.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл sites.view; ключ без нього відхиляється з кодом 403, а не 404.
Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X POST https://api.zinndigital.com/v1/compute/servers/{serverId}/services/action \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "unit": <string>, "action": <string<start, stop, restart>> }'Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
Acts on a single service unit inside the machine - Apache, MariaDB, ProFTPD - while the machine itself stays up. This is the difference between a customer whose site is down fixing it themselves in ten seconds and a customer opening a ticket. ⛔ Not the same blast radius as setComputeServerPower. That one moves the whole machine; this moves one unit inside a machine that keeps running. Stopping a web server or a database still takes every website on that box off the air, so the operation is audit-logged with the real actor. ⛔ unit must be a service the machine is currently running. The engine checks the name against the machine's own live service list before sending anything, so an arbitrary systemd unit - sshd.service, a firewall, the enrolment agent - is refused with a 422 that names what is available instead. The list this endpoint's sibling listComputeServerServices returns is exactly the set that may be named here. The response carries the provider's own confirmation sentence, which is worth showing to the customer verbatim. 404 for a server that is not the caller's; 422 for a machine that is not active, a unit it does not run, or a verb outside start/stop/restart. Requires sites.view and sites.restart.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
serverId (path) | Uuid | Так | The server's id, as listComputeServers reports it. Ours (UUIDv7), minted when the order row was written — never the provider's own identifier for the machine. |
Тіло запиту
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
unit | string | Так | The service unit to act on, exactly as listComputeServerServices reports it (httpd.service, mariadb.service, proftpd.service). ⛔ Must be a unit the machine is… |
action | string<start, stop, restart> | Так | ⛔ A closed vocabulary. reload, enable and disable are deliberately absent: they have never been proven against a provider, and a verb we have not proven is a button that may… |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
message | string | Так | The provider's own confirmation sentence — "Service proftpd.service was stopped successfully." — passed through verbatim, because it is more specific than anything we would… |
Помилки, які може повертати ця кінцева точка
401 · 403 · 404 · 422 · 429 · 503