Sanggunian ng API
compute
104 mga endpoint sa lugar na ito. Ang bawat isa ay may sariling pahina kasama ang mga parameter nito, ang tugon nito, at isang kahilingan na maaari ninyong patakbuhin.
| Paraan | Path | Ang ginagawa nito | Pahintulot |
|---|---|---|---|
| GET | /v1/certificates/orders | This organisation's certificate orders. | sites.view |
| POST | /v1/certificates/orders | Start a certificate order. Spends nothing. | billing.payment.manage |
| DELETE | /v1/certificates/orders/{orderId} | Cancel an order inside the authority's refund window. | billing.payment.manage |
| GET | /v1/certificates/orders/{orderId} | One certificate order. | sites.view |
| POST | /v1/certificates/orders/{orderId}/refresh | Ask the authority where this order actually got to. | sites.view |
| POST | /v1/certificates/orders/{orderId}/renew | Start the successor order for an expiring certificate. | billing.payment.manage |
| POST | /v1/certificates/orders/{orderId}/submit | Buy the certificate. This spends money. | billing.payment.manage |
| GET | /v1/certificates/products | TLS certificates a customer can buy. | sites.view |
| GET | /v1/compute/add-ons | What can be bought to run ON a Zinn® Private Cloud machine. | sites.view |
| GET | /v1/compute/catalogue | Get everything the server order screen is built from. | sites.view |
| GET | /v1/compute/clusters | The organisation's Kubernetes clusters. | sites.view |
| POST | /v1/compute/clusters | Create a k3s cluster, optionally with Argo CD. | billing.payment.manage |
| POST | /v1/compute/clusters/quote | What a cluster costs, before it is built. | sites.view |
| DELETE | /v1/compute/clusters/{clusterId} | Delete a cluster and every machine in it. | sites.delete |
| GET | /v1/compute/clusters/{clusterId} | One cluster, with its machines and what it reports. | sites.view |
| GET | /v1/compute/clusters/{clusterId}/kubeconfig | Download the cluster's kubeconfig. | sites.delete |
| GET | /v1/compute/eligibility | Whether this organisation may buy a machine on our own cloud. | sites.view |
| POST | /v1/compute/eligibility | Submit an organisation for verification. | billing.payment.manage |
| POST | /v1/compute/eligibility/document | Get a presigned upload slot for the ID-check document. | billing.payment.manage |
| POST | /v1/compute/eligibility/verify-email | Email the caller a link that verifies their address. | sites.view |
| GET | /v1/compute/networks | The organisation's private networks. | sites.view |
| POST | /v1/compute/networks | Create a private network from a server. | sites.restart |
| DELETE | /v1/compute/networks/{networkId} | Delete a private network. | sites.delete |
| GET | /v1/compute/regions | List the cloud regions a machine can be bought in right now. | sites.view |
| GET | /v1/compute/regions/resolve | Answer "can I have a machine in this place?" without placing anything. | sites.view |
| GET | /v1/compute/servers | List the servers in scope. | sites.view |
| POST | /v1/compute/servers | Order a server. | sites.view |
| POST | /v1/compute/servers/metered | Order a server paid for by the hour from the account balance. | billing.payment.manage, sites.view |
| GET | /v1/compute/servers/{serverId} | Get one server, with the provider's live state merged in. | sites.view |
| DELETE | /v1/compute/servers/{serverId}/add-on | Cancel this machine's add-on and release its licence. | sites.view |
| GET | /v1/compute/servers/{serverId}/add-on | The add-on this machine carries. | sites.view |
| POST | /v1/compute/servers/{serverId}/add-on | Buy an add-on for this machine. | sites.view |
| POST | /v1/compute/servers/{serverId}/add-on/panel-login | Enable one-click Plesk sign-in on this machine, with your consent. | sites.view |
| GET | /v1/compute/servers/{serverId}/backups | A server's automatic backup arrangement. | sites.view |
| POST | /v1/compute/servers/{serverId}/backups | Turn a server's automatic backups on or off. | billing.payment.manage |
| GET | /v1/compute/servers/{serverId}/backups/tier | The machine's backup tier, and what upgrading would cost. | sites.view |
| POST | /v1/compute/servers/{serverId}/backups/tier | Move the machine between the standard and extended backup tiers. | billing.payment.manage |
| POST | /v1/compute/servers/{serverId}/cancel | Retire a server at the provider. | sites.view |
| POST | /v1/compute/servers/{serverId}/console | Open an out-of-band console onto a server. | sites.restart |
| DELETE | /v1/compute/servers/{serverId}/console/allow | Revoke every address's console access. | sites.restart |
| POST | /v1/compute/servers/{serverId}/console/allow | Let one address reach an IP-gated console. | sites.restart |
| GET | /v1/compute/servers/{serverId}/firewall | A server's network filter. | sites.view |
| PUT | /v1/compute/servers/{serverId}/firewall | Replace a server's firewall rules. | sites.restart |
| GET | /v1/compute/servers/{serverId}/floating-ips | The floating IPs routed to a server. | sites.view |
| POST | /v1/compute/servers/{serverId}/floating-ips | Reserve a floating IP and route it to a server. | billing.payment.manage |
| POST | /v1/compute/servers/{serverId}/floating-ips/quote | What a floating IP on this server costs per month. | sites.view |
| DELETE | /v1/compute/servers/{serverId}/floating-ips/{floatingIpId} | Release a floating IP. | sites.delete |
| GET | /v1/compute/servers/{serverId}/health | Read a server's hardware and live resource usage. | sites.view |
| GET | /v1/compute/servers/{serverId}/images | What this machine may be rebuilt to. | sites.view |
| PUT | /v1/compute/servers/{serverId}/install-media | Mount an installer disc (restarts the machine) or eject it. | sites.delete |
| GET | /v1/compute/servers/{serverId}/limits | What a server may hold. | sites.view |
| GET | /v1/compute/servers/{serverId}/metrics | How hard a server has worked over a window — CPU, network and disk rates. | sites.view |
| POST | /v1/compute/servers/{serverId}/name | Rename a server. | sites.restart |
| POST | /v1/compute/servers/{serverId}/networks | Join a server to one of the organisation's private networks. | sites.restart |
| DELETE | /v1/compute/servers/{serverId}/networks/{networkId} | Take a server off a private network. | sites.restart |
| GET | /v1/compute/servers/{serverId}/overage | What this machine owes for bandwidth over its allowance this month. | sites.view |
| GET | /v1/compute/servers/{serverId}/plan | What this machine costs, and what else it could have. | sites.view |
| POST | /v1/compute/servers/{serverId}/plan | Buy one paid option for this machine. | billing.payment.manage, sites.view |
| DELETE | /v1/compute/servers/{serverId}/plan/{purchaseId} | Stop paying for one option — where the provider permits it. | billing.payment.manage |
| POST | /v1/compute/servers/{serverId}/power | Start, stop or reboot a server. | sites.view |
| POST | /v1/compute/servers/{serverId}/rebuild | Reinstall a server's operating system. | sites.view |
| GET | /v1/compute/servers/{serverId}/recovery | Read a server's rescue mode and installer-disc state. | sites.view |
| POST | /v1/compute/servers/{serverId}/renew | Extend a server's term. | sites.view |
| GET | /v1/compute/servers/{serverId}/renewal | Read a server's billing contract. | sites.view |
| POST | /v1/compute/servers/{serverId}/rescue | Turn rescue mode on or off. ⛔ Restarts the machine. | sites.delete |
| POST | /v1/compute/servers/{serverId}/resize | Move a server onto another machine size. | sites.view |
| POST | /v1/compute/servers/{serverId}/resize/quote | Get what resizing a server would cost, before the charge. | sites.view |
| GET | /v1/compute/servers/{serverId}/reverse-dns | The PTR of every public address on a machine. | sites.view |
| PUT | /v1/compute/servers/{serverId}/reverse-dns | Point one address's PTR at a hostname, or reset it. | sites.restart |
| POST | /v1/compute/servers/{serverId}/root-password | Reset a server's root password. ⛔ Reboots the machine. | sites.delete |
| GET | /v1/compute/servers/{serverId}/services | List the services running inside a server. | sites.view |
| POST | /v1/compute/servers/{serverId}/services/action | Start, stop or restart one service inside a server. | sites.view |
| GET | /v1/compute/servers/{serverId}/snapshots | List a server's on-demand disk images. | sites.view |
| POST | /v1/compute/servers/{serverId}/snapshots | Take a snapshot of a server now. | billing.payment.manage |
| DELETE | /v1/compute/servers/{serverId}/snapshots/{snapshotId} | Delete a snapshot. | sites.view |
| POST | /v1/compute/servers/{serverId}/snapshots/{snapshotId} | Roll a server back to a snapshot. | sites.view |
| GET | /v1/compute/servers/{serverId}/software | List the software available on a server. | sites.view |
| POST | /v1/compute/servers/{serverId}/terminal | Mint a single-use ticket for one web terminal session on a server. | sites.restart |
| DELETE | /v1/compute/servers/{serverId}/terminal/host-key | Trust a server's new SSH identity on the next terminal connection. | sites.restart |
| GET | /v1/compute/servers/{serverId}/usage | One server's metered hours, charges and ledger check for a month. | sites.view |
| GET | /v1/compute/spend-cap | Read the organisation's monthly limit on metered compute. | sites.view |
| PUT | /v1/compute/spend-cap | Set or clear the organisation's monthly limit on metered compute. | billing.payment.manage, sites.view |
| GET | /v1/compute/ssh-keys | The SSH keys this organisation has registered. | sites.view |
| POST | /v1/compute/ssh-keys | Register a public key so a future order can install it. | billing.payment.manage |
| DELETE | /v1/compute/ssh-keys/{keyId} | Forget a registered key. | billing.payment.manage |
| DELETE | /v1/compute/terminal | Turn the web terminal off — destroy the organisation's terminal key. | billing.payment.manage |
| GET | /v1/compute/terminal | Whether the web terminal is turned on for an organisation. | sites.view |
| POST | /v1/compute/terminal | Turn the web terminal on — mint the organisation's terminal key. | billing.payment.manage |
| GET | /v1/compute/vps/options | The paid options a VPS of a given size can carry. | sites.view |
| GET | /v1/compute/vps/quote | What one configured VPS costs, itemised. | sites.view |
| GET | /v1/panels/connections | The control panels this organisation has connected. | sites.view |
| POST | /v1/panels/connections | Connect a running Plesk panel so it can be managed from here. | connections.manage |
| DELETE | /v1/panels/connections/{connectionId} | Disconnect a panel and delete its stored credential. | connections.manage |
| GET | /v1/panels/connections/{connectionId} | One connected control panel. | sites.view |
| POST | /v1/panels/connections/{connectionId}/check | Re-probe what this panel can actually do. | connections.manage |
| GET | /v1/panels/connections/{connectionId}/clients | The customer accounts held on this panel. | sites.view |
| GET | /v1/panels/connections/{connectionId}/domains | The websites this panel is serving. | sites.view |
| POST | /v1/panels/connections/{connectionId}/install-licence | Install a licence we bought onto this panel. | connections.manage |
| POST | /v1/panels/connections/{connectionId}/login-link | One-click login — a one-time administrative session on the panel. | sites.panel_access |
| GET | /v1/panels/licences | The control-panel licences this organisation holds. | sites.view |
| POST | /v1/panels/licences | Buy a control-panel licence. | billing.payment.manage |
| DELETE | /v1/panels/licences/{licenceId} | Release a licence — the only thing that stops the charge. | billing.payment.manage |
| GET | /v1/panels/licences/{licenceId} | One control-panel licence. | sites.view |
| GET | /v1/panels/products | Control-panel editions and extensions a customer can buy. | sites.view |