All endpoints¶
171 endpoints, in alphabetical order. Each links to its full description.
| Action | Method | Section | Description |
|---|---|---|---|
acceptorder |
POST | Orders | Accept/approve a pending order |
acceptquote |
POST | Quotes | Accept a quote and raise its invoice |
activatemodule |
POST | System | Switch a module on |
addannouncement |
POST | System | Create a new announcement |
addbannedip |
POST | System | Ban an IP address or range |
addbillableitem |
POST | Invoices & Billing | Add a billable item for a client |
addcancelrequest |
POST | Services & Products | Request cancellation of a service |
addclient |
POST | Clients | Create a new client account |
addclientnote |
POST | Clients | Add a note to a client's account |
addcontact |
POST | Clients | Add a sub-contact to a client |
addcredit |
POST | Clients | Add credit to a client's account balance |
addinvoicepayment |
POST | Invoices & Billing | Record a manual payment for an invoice |
addorder |
POST | Orders | Create a new order for a client |
addpaymethod |
POST | Invoices & Billing | Add a stored payment method (not available) |
addproduct |
POST | Services & Products | Create a new product/package |
addprojectmessage |
POST | Projects | Add a message/comment to a project |
addprojecttask |
POST | Projects | Add a task to a project |
addsslorder |
POST | SSL Certificates | Create an SSL certificate order |
addticketnote |
POST | Support Tickets | Add a staff note to a ticket |
addticketreply |
POST | Support Tickets | Add a reply to an existing ticket |
addtransaction |
POST | Invoices & Billing | Add a manual transaction record |
adduser |
POST | Clients | Create a client-area login |
affiliateactivate |
POST | Affiliates | Make a client an affiliate |
applycredit |
POST | Clients | Apply client credit to an invoice |
blockticketsender |
POST | Support Tickets | Block a ticket sender |
cancelorder |
POST | Orders | Cancel an order |
cancelsslorder |
POST | SSL Certificates | Revoke an SSL certificate |
capturepayment |
POST | Invoices & Billing | Charge a stored payment method (not available) |
closeclient |
POST | Clients | Close a client account |
configsslorder |
POST | SSL Certificates | Send the CSR and details for an SSL order |
createclientinvite |
POST | Clients | Invite someone to a client account |
createinvoice |
POST | Invoices & Billing | Create a new invoice |
createoauthcredential |
POST | API Credentials | Create an API credential |
createorupdatetld |
POST | Domains | Create or update a domain extension and its prices |
createproject |
POST | Projects | Create a new project |
createquote |
POST | Quotes | Create a new quote for a client |
createssotoken |
POST | Clients | Create a one-time sign-in link to the client area |
deactivatemodule |
POST | System | Switch a module off |
decryptpassword |
POST | System | Decrypt a value (not available) |
deleteannouncement |
POST | System | Delete an announcement |
deleteclient |
POST | Clients | Delete a client account |
deletecontact |
POST | Clients | Delete a sub-contact |
deleteoauthcredential |
POST | API Credentials | Delete an API credential |
deleteorder |
POST | Orders | Delete an order |
deletepaymethod |
POST | Invoices & Billing | Remove a stored payment method |
deleteprojecttask |
POST | Projects | Delete a task from a project |
deletequote |
POST | Quotes | Delete a quote |
deleteticket |
POST | Support Tickets | Delete a ticket and all its replies |
deleteticketnote |
POST | Support Tickets | Delete a staff note from a ticket |
deleteticketreply |
POST | Support Tickets | Delete a specific ticket reply |
deleteuserclient |
POST | Clients | Remove a login from a client account |
domaingetlockingstatus |
GET | Domains | Get the registrar lock status of a domain |
domaingetnameservers |
GET | Domains | Get the nameservers of a domain |
domaingetwhoisinfo |
GET | Domains | Get the contact details of a domain |
domainregister |
POST | Domains | Register a new domain |
domainrelease |
POST | Domains | Release a domain to another registrar |
domainrenew |
POST | Domains | Renew an existing domain |
domainrequestepp |
GET | Domains | Get the transfer (EPP) code of a domain |
domaintoggleidprotect |
POST | Domains | Turn ID protection on or off |
domaintransfer |
POST | Domains | Transfer a domain to this registrar |
domainupdatelockingstatus |
POST | Domains | Lock or unlock a domain at the registrar |
domainupdatenameservers |
POST | Domains | Change the nameservers of a domain |
domainupdatewhoisinfo |
POST | Domains | Change the contact details of a domain (not available) |
domainwhois |
GET | Domains | Check whether a domain is available to register |
encryptpassword |
POST | System | Encrypt a value (not available) |
endtasktimer |
POST | Projects | Stop a task timer |
fraudorder |
POST | Orders | Mark an order as fraudulent |
geninvoices |
POST | Invoices & Billing | Generate the invoices that are due |
getactivitylog |
GET | System | List the activity log |
getadmindetails |
GET | System | Get a staff account (the caller by default) |
getadminusers |
GET | System | List the staff accounts |
getaffiliates |
GET | Affiliates | List affiliates |
getannouncements |
GET | System | List the published announcements |
getautomationlog |
GET | System | List the activity log (automation) |
getcancelledpackages |
GET | Services & Products | List cancellation requests |
getclientgroups |
GET | Clients | List all client groups |
getclientpassword |
GET | Clients | Read a client password (not available) |
getclients |
GET | Clients | List clients with optional search/filtering |
getclientsaddons |
GET | Services & Products | Get all addons for a client |
getclientsdetails |
GET | Clients | Get full details for a single client |
getclientsdomains |
GET | Domains | List domains for a specific client |
getclientsproducts |
GET | Services & Products | List services/products for a client |
getconfigurationvalue |
GET | System | Read a setting |
getcontacts |
GET | Clients | Get sub-contacts for a client |
getcredits |
GET | Clients | List credit entries |
getcurrencies |
GET | Invoices & Billing | List all configured currencies |
getemails |
GET | System | List the mail sent to clients |
getemailtemplates |
GET | System | List the email templates |
gethealthstatus |
GET | System | Check system health and service status |
getinvoice |
GET | Invoices & Billing | Get a single invoice with line items |
getinvoices |
GET | Invoices & Billing | List invoices with optional filtering |
getmoduleconfigurationparameters |
GET | System | List the settings a module asks for |
getmodulequeue |
GET | System | List server actions waiting to be retried |
getorders |
GET | Orders | List all orders with optional filtering |
getorderstatuses |
GET | System | Get available order status options |
getpaymentmethods |
GET | System | List the payment gateways clients can pay with |
getpaymethods |
GET | Invoices & Billing | List a client's stored payment methods |
getpermissionslist |
GET | System | List the staff permission keys |
getproducts |
GET | System | List all products/packages in the system |
getproject |
GET | Projects | Get a single project with tasks and messages |
getprojects |
GET | Projects | List all projects |
getpromotions |
GET | System | List promotion codes |
getquotes |
GET | Quotes | List all quotes with optional filtering |
getregistrars |
GET | System | List the installed registrar modules |
getservers |
GET | System | List the servers |
getsslapproveremails |
GET | SSL Certificates | List the addresses that may approve a certificate |
getsslorder |
GET | SSL Certificates | Get one SSL order |
getsslorders |
GET | SSL Certificates | List SSL orders |
getstaffonline |
GET | System | List the staff signed in during the last 15 minutes |
getstats |
GET | System | Count clients, services, domains, invoices, orders, tickets and staff |
getsupportdepartments |
GET | Support Tickets | List all support departments |
getsupportstatuses |
GET | Support Tickets | List the ticket statuses |
getticket |
GET | Support Tickets | Get a single ticket with replies |
getticketattachment |
GET | Support Tickets | List or download the files on a ticket |
getticketcounts |
GET | Support Tickets | Count tickets by status |
getticketnotes |
GET | Support Tickets | List the staff notes on a ticket |
getticketpredefinedcats |
GET | Support Tickets | List the canned reply categories |
getticketpredefinedreplies |
GET | Support Tickets | List canned replies |
gettickets |
GET | Support Tickets | List support tickets with optional filtering |
gettldpricing |
GET | Domains | Get the prices of the enabled domain extensions |
gettodoitems |
GET | System | List to-do items |
gettodoitemstatuses |
GET | System | List the to-do statuses |
gettransactions |
GET | Invoices & Billing | List payment transactions with optional filtering |
getuserpermissions |
GET | Clients | Get what a login may do on a client account |
getusers |
GET | Clients | List client-area logins |
listoauthcredentials |
GET | API Credentials | List the API credentials |
logactivity |
POST | System | Write an entry in the activity log |
mergeticket |
POST | Support Tickets | Merge one ticket into another |
modulechangepackage |
POST | Services & Products | Run Change Package on a service module |
modulechangepw |
POST | Services & Products | Change the account password on the server |
modulecreate |
POST | Services & Products | Run the module Create function for a service |
modulecustom |
POST | Services & Products | Run a custom function of a server module |
modulesuspend |
POST | Services & Products | Suspend a hosting service |
moduleterminate |
POST | Services & Products | Run the module Terminate function |
moduleunsuspend |
POST | Services & Products | Unsuspend/reactivate a service |
openticket |
POST | Support Tickets | Open a new support ticket |
orderfraudcheck |
POST | Orders | Score an order for fraud |
pendingorder |
POST | Orders | Set an order back to pending |
pnlcsdetails |
GET | System | Get installation details (version, company name) |
reissuesslorder |
POST | SSL Certificates | Reissue an SSL certificate |
resendsslvalidation |
POST | SSL Certificates | Resend the SSL validation email |
resetpassword |
POST | System | Send a client login the password reset link |
sendadminemail |
POST | System | Send an email to the staff |
sendemail |
POST | System | Send a client a template or custom email |
sendquote |
POST | Quotes | Mark a quote as sent to the client |
setconfigurationvalue |
POST | System | Change a setting |
starttasktimer |
POST | Projects | Start a task timer |
triggernotificationevent |
POST | System | Send a custom notification |
updateadminnotes |
POST | System | Replace the admin notes on a client |
updateannouncement |
POST | System | Update an announcement |
updateclient |
POST | Clients | Update an existing client's details |
updateclientaddon |
POST | Services & Products | Update a service addon |
updateclientdomain |
POST | Domains | Update a domain record |
updateclientproduct |
POST | Services & Products | Update a client's hosting service record |
updatecontact |
POST | Clients | Update a sub-contact |
updateinvoice |
POST | Invoices & Billing | Update an existing invoice |
updatemoduleconfiguration |
POST | System | Change a module's settings |
updateoauthcredential |
POST | API Credentials | Update an API credential |
updatepaymethod |
POST | Invoices & Billing | Rename a stored payment method or make it the default |
updateproject |
POST | Projects | Update a project's details |
updateprojecttask |
POST | Projects | Update a project task |
updatequote |
POST | Quotes | Update an existing quote |
updateticket |
POST | Support Tickets | Update ticket status or details |
updateticketreply |
POST | Support Tickets | Edit a ticket reply |
updatetodoitem |
POST | System | Update a to-do item |
updatetransaction |
POST | Invoices & Billing | Update a transaction |
updateuser |
POST | Clients | Update a client-area login |
updateuserpermissions |
POST | Clients | Change what a login may do on a client account |
upgradeproduct |
POST | Services & Products | Move a service to another product, billing the difference |
validatelogin |
POST | System | Validate client login credentials |
whmcsdetails |
GET | System | Get installation details (WHMCS name) |