Sive.Host SHAPI
SHAPI exposes customer-owned Sive.Host billing, compute, hosting, domain, support, and DirectAdmin operations as JSON.
Direct API
- Sign in at the SHAPI client page.
- Create or enable an API key and secret.
- Add the public egress IP used by your integration.
- Copy the HTTP Basic username/password shown on that authenticated page.
- POST URL-encoded requests to
https://sive.host/modules/addons/shapi/sh-api.php.
ChatGPT plugin
Add https://sh.sive.ai/mcp as a ChatGPT plugin connection named Sive.Host, or use the equivalent alias https://ai.paas.africa/mcp. OAuth asks for the same customer API key and secret. ChatGPT does not need the HTTP Basic values.
Authorization model
The client ID is derived from the API key. Request-supplied client IDs are ignored. Service, domain, invoice, and ticket ownership is checked server-side. Partner actions additionally verify the active Partner, the selected Partner-client relationship, the Partner-service assignment, and the service owner.
Current action catalog (96)
| Action | Risk | Purpose |
|---|---|---|
AccountSummary | Read | Return a limited profile, status, currency, credit balance, and account statistics for the authenticated client. |
CreditCheck | Read | Return the authenticated client credit balance and currency. |
ListActiveProducts | Read | List active public products and pricing through the custom WHMCS GetProductsActive API action. |
ListServices | Read | List services owned by the authenticated client. |
GetPartnerContext | Read | Identify an active Sive.Host Partner and return separate owned and Partner-managed active-service counts. |
GetPartnerStorefront | Read | Return the authenticated active Partner storefront identity, VAT, contact, social, colour and default-currency settings without exposing credentials or payment configuration. |
UpdatePartnerStorefront | Write | Update allowlisted settings for the authenticated Partner storefront. |
ListPartnerCatalog | Read | List products, addons and domain operations in the authenticated Partner Pricing Group with per-currency administrator bounds and Partner retail prices. |
SetPartnerCatalogPricing | Destructive | Activate, reprice or deactivate one Pricing Group item for the authenticated Partner. |
SetPartnerProductDisplay | Write | Set a Partner-specific storefront product name and plain-text description. |
ListPartnerClients | Read | List clients explicitly assigned to the authenticated active Partner without returning credentials. |
ListPartnerClientServices | Read | List hosting and compute services explicitly assigned to the Partner for one active Partner client. |
ListClientDomains | Read | List WHMCS domain registrations owned by the authenticated client. |
ListInvoices | Read | List invoices owned by the authenticated client. |
GetInvoice | Read | Return one invoice after verifying client ownership. |
ListTickets | Read | List support tickets owned by the authenticated client. |
GetTicket | Read | Return one support ticket after verifying client ownership. |
OpenTicket | Write | Open a support ticket as the authenticated client. |
NameCheck | Read | Check whether a valid domain is available for registration. No minimum credit is required. |
NamePrice | Read | Return registration, transfer, and renewal pricing for configured TLDs in the client currency. No minimum credit is required. |
BuyDomain | Destructive | Register an available domain through WHMCS and create the related order and invoice. |
ListComputeOrderOptions | Read | List product-linked operating systems and, after an OS is selected, only the compatible application recipes. |
BuyNow | Destructive | Order one supported VM or container product with an explicit OS and optional compatible application recipe. |
BuyShared | Destructive | Order one supported shared-hosting product. |
StartVM | Write | Start an owned VM or container. |
StopVM | Write | Stop an owned VM or container. |
BuyClone | Destructive | Clone an owned VM or container and create a billable service. |
ListComputeReinstallOptions | Read | List operating systems and optional application recipes allowed for reinstalling an owned active VPS. |
ReinstallCompute | Destructive | Erase and reinstall an owned active Proxmox VPS with an allowed operating system and optional application recipe. |
QuoteComputeResource | Read | Calculate the current prorated WHMCS price for bandwidth, backup quota, IPv4, or a private internal network. |
BuyComputeBandwidth | Destructive | Buy additional recurring bandwidth in 500 GB units through the WHMCS upgrade engine. |
BuyComputeBackup | Destructive | Buy additional recurring Proxmox backup quota in 1 GB units through the WHMCS upgrade engine. |
BuyComputeIPv4 | Destructive | Buy additional recurring dedicated IPv4 addresses through the WHMCS upgrade engine. |
BuyComputePrivateNetwork | Destructive | Buy and provision the one managed private internal network available to an eligible VPS. |
AddNewDisk | Destructive | Purchase and attach a new SSD or HDD disk to an owned VM or container. |
IncreaseDiskSize | Destructive | Purchase capacity and grow an existing disk. |
AddMoreCPU | Destructive | Purchase and add CPU cores to an owned VM or container. |
AddMoreRAM | Destructive | Purchase and add RAM to an owned VM or container. |
ReassignDisk | Destructive | Move a disk between two compute services owned by the same client. |
FirewallPolicyOption | Write | Set a firewall policy option on an owned VM or container. |
AddFirewallRule | Write | Add a firewall rule to an owned VM or container. |
EditFirewallRule | Write | Edit an existing firewall rule on an owned VM or container. |
MigrateVM | Destructive | Migrate an owned VM or container to an allowed target node. |
accDetail | Read | Return control-panel account details for an owned active hosting service. |
accQuota | Read | Return quota usage for an owned active hosting service. |
accExist | Read | Check the control-panel account for an owned active hosting service. |
quotaLimit | Read | Return configured quota limits for an owned active hosting service. |
addSSL | Write | Provision a certificate for a domain in an owned hosting service. |
delSSL | Destructive | Delete certificate records for a domain in an owned hosting service. |
autoLogin | Write | Create a short-lived control-panel login URL for an owned service. |
passwdUpd | Destructive | Change the main hosting control-panel password. |
cronList | Read | List cron jobs in an owned hosting service. |
cronAdd | Write | Create a cron job in an owned hosting service. |
cronDel | Destructive | Delete the cron job matching a schedule and command. |
domainsList | Read | List domains or subdomains in an owned hosting service. |
domainsAdd | Write | Add a domain or subdomain to an owned hosting service. |
domainsDel | Destructive | Delete a domain or subdomain from an owned hosting service. |
ReadHostingDomainLog | Read | Read a bounded tail of an owned DirectAdmin domain access or error log. |
ListWebsiteFiles | Read | List files beneath a customer domain public_html directory through DirectAdmin. |
ReadWebsiteFile | Read | Read one file beneath a customer domain public_html directory. |
BackupWebsiteFile | Write | Copy one public_html file into the managed Sive.Host MCP backup directory outside public_html. |
PublishWebsiteFile | Destructive | Publish one file beneath a customer domain public_html directory using DirectAdmin multipart upload. |
RestoreWebsiteFile | Destructive | Restore an exact Sive.Host MCP backup into the same domain public_html directory. |
DeleteWebsiteFiles | Destructive | Move selected public_html files or directories to the DirectAdmin trash. |
listEmail | Read | List mailboxes in an owned hosting service. |
addEmail | Write | Create a mailbox and encrypt its password for the SHAPI mail tools. |
udpEmail | Destructive | Change a mailbox password and quota and update the encrypted SHAPI credential. |
delEmail | Destructive | Permanently delete a mailbox. |
suspEmail | Write | Suspend a mailbox. |
unspEmail | Write | Unsuspend a mailbox. |
ConnectMailbox | Destructive | Optionally verify an owned mailbox over IMAP and store its password encrypted as a fallback. Passwordless DirectAdmin delegation is used normally. |
SendMailboxEmail | Destructive | Send email from an exact owned mailbox through a short-lived DirectAdmin/Roundcube delegated session without requesting its password. |
ReplyMailboxMessage | Destructive | Send a true threaded reply to one existing owned mailbox message through passwordless DirectAdmin/Roundcube delegation. |
ListMailboxMessages | Read | List message metadata from any existing owned mailbox through passwordless DirectAdmin/Roundcube delegation. |
GetMailboxMessage | Read | Read one message from any existing owned mailbox by UID through passwordless delegation. |
SetMailboxMessageReadState | Write | Mark one existing owned mailbox message read or unread through passwordless delegation. |
ftpList | Read | List FTP accounts in an owned hosting service. |
ftpAdd | Write | Create an FTP account. |
ftpUpd | Destructive | Change an FTP account password. |
ftpDel | Destructive | Delete an FTP account. |
dbList | Read | List databases in an owned hosting service. |
dbAdd | Write | Create a database and initial user. |
dbDel | Destructive | Permanently delete a database. |
dbuserList | Read | List database users in an owned hosting service. |
dbuserAdd | Write | Create a database user and grant database access. |
dbuserUpd | Destructive | Change a database user password or allowed host. |
dbuserDel | Destructive | Delete a database user. |
PartnerCreateControlPanelLogin | Write | Create a short-lived DirectAdmin login URL for an explicitly assigned active Partner client service. |
PartnerDirectAdminLegacyRead | Read | Call a user-scoped DirectAdmin legacy CMD_API_* endpoint with GET for an explicitly assigned Partner client service. |
PartnerDirectAdminLegacyWrite | Destructive | Call a user-scoped DirectAdmin legacy CMD_API_* endpoint with POST for an explicitly assigned Partner client service. |
PartnerDirectAdminModernRead | Read | Call a user-scoped DirectAdmin /api/* endpoint with GET for an explicitly assigned Partner client service. |
PartnerDirectAdminModernWrite | Destructive | Call a user-scoped DirectAdmin /api/* endpoint with POST, PUT, PATCH, or DELETE for an explicitly assigned Partner client service. |
DirectAdminLegacyRead | Read | Call a user-scoped DirectAdmin legacy CMD_API_* endpoint with GET for an owned DirectAdmin service. |
DirectAdminLegacyWrite | Destructive | Call a user-scoped DirectAdmin legacy CMD_API_* endpoint with POST for an owned DirectAdmin service. |
DirectAdminModernRead | Read | Call a user-scoped DirectAdmin modern /api/* endpoint with GET for an owned DirectAdmin service. |
DirectAdminModernWrite | Destructive | Call a user-scoped DirectAdmin modern /api/* endpoint with POST, PUT, PATCH, or DELETE. |
SHAPI documentation version 2.0.
