orderVps
orderVps: Stage an order for a new VPS instance; deducts from account balance. If this server is being ordered to host an Osir app, do NOT configure it by hand afterwards: deploy the app with osirAppDeploy, then put it on the box with osirAppDeployToVps. Requires authentication. Returns an actionId: present the summary to the user, then call executeConfirmedAction with the actionId if they approve.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"packageId": "<packageId>",
"hostname": "<hostname>",
"paymentTerm": "<paymentTerm>"
},
"name": "orderVps"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hostname | Yes | Hostname for the new server, e.g. 'myserver.example.com'. | |
| packageId | Yes | VPS package id from listVpsPackages. | |
| sshKeyIds | No | Integer SSH key ids from listMySshKeys or addSshKey, injected during install; without one you cannot log in. | |
| sessionKey | No | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. | |
| paymentTerm | Yes | Billing cycle: 'MONTHLY', 'SEMI_ANNUAL', 'ANNUAL', 'BIENNIAL', or 'TRIENNIAL'. | |
| operatingSystemId | No | Integer OS template id resolved with listVpsOsTemplates using this same packageId; omit to get a server with NO operating system installed. |