All services and orders

How-to guides

Services (all products) 8

Generic bridge to every product line (cloud server, VDS, dedicated, mail, monitor, storage, license, ...). Everything a customer can do on a service in the client area is a module tool or method and is reachable here. Start with GET /cloud/services/{id}/tools: it lists the tools, their actions and our safety policy (read, confirm, secret) for that very service.

• GET/cloud/servicesList services of every product line
• GET/cloud/services/{id}Get a service (renewal, cancellation, access details)
• GET/cloud/services/{id}/toolsDiscover tools, actions and safety policy of a service
• GET/cloud/services/{id}/tools/{tool}Read a tool (list mailboxes, snapshots, DNS records, ...)
• POST/cloud/services/{id}/tools/{tool}/{action}Run a tool action (create a mailbox, restore a snapshot, ...)
• POST/cloud/services/{id}/methods/{method}Call a client-callable module method (e.g. license change_ip)
• GET/cloud/services/{id}/labelGet the nickname and tags of a service
• PUT/cloud/services/{id}/labelSet the nickname and/or tags of a service

Services (core) 18

Core service endpoints: renew, cancel, auto-renew, add-ons, metrics, SSO, password.

• GET/servicesList services
• GET/services/{id}Get service (path: {id})
• PATCH/services/{id}Update service (path: {id})
• POST/services/{id}/renewRenew service (path: {id})
• GET/services/{id}/invoicesList service invoices (path: {id})
• GET/services/{id}/addonsList service addons (path: {id})
• POST/services/{id}/cancellationCreate cancellation (path: {id})
• DELETE/services/{id}/cancellationRevoke cancellation (path: {id})
• GET/services/{id}/metricsGet service metrics (path: {id})
• GET/services/{id}/metrics/billingList service metric billing (path: {id})
• PATCH/services/{id}/metrics/{key}Update service metric (path: {id}, {key})
• GET/services/{id}/dashboardGet service dashboard (path: {id})
• GET/services/{id}/toolsGet service tools (path: {id})
• GET/services/{id}/tools/{tool}Get service tool data (path: {id}, {tool})
• POST/services/{id}/tools/{tool}/{action}Run service tool action (path: {id}, {tool}, {action})
• POST/services/{id}/module-methodUse service module method (path: {id})
• POST/services/{id}/ssoGet service sso (path: {id})
• POST/services/{id}/passwordChange service password (path: {id})

Plan changes and add-ons 6

Resize (plan upgrade) and add-on purchase, paid from the account balance (dry_run, confirm, Idempotency-Key, daily limit: default 50 paid operations per account, per-account/reseller override, 429 daily_limit).

• GET/cloud/services/{id}/resize-optionsProducts this service can be upgraded to, with prices
• POST/cloud/services/{id}/resizeUpgrade the plan (paid from balance)
• GET/cloud/services/{id}/addons/availableAdd-ons offered for this service (with options and prices)
• GET/cloud/services/{id}/addonsAdd-ons the service holds
• POST/cloud/services/{id}/addonsBuy an add-on (paid from balance)
• DELETE/cloud/services/{id}/addons/{aid}Remove a prepaid add-on at once

Licenses 2

Software license status and IP change.

• GET/cloud/licenses/{id}GET method license_status (LisansAPP)
• POST/cloud/licenses/{id}/change-ipPOST method change_ip (LisansAPP)

Orders 4

Preview (quote) and place orders for any product.

• GET/ordersList orders
• POST/ordersCreate order
• POST/orders/previewPreview order
• GET/orders/{id}Get order (path: {id})