API Reference
166 routes of the gateway https://api.tino.vn/v1 and the TinoPay, Tino Uptime and TinoPage Builder service APIs, by product. Each route has a page: parameters, cURL, JavaScript, PHP and SDK examples, response sample. Authentication, sending parameters and common errors: Calling the Tino API. Machine-readable: /en/openapi.json.
Identity & SSO
Account
| Method | Path | Name | Scope |
|---|---|---|---|
GET | /v1/clientarea | Account overview | profile:read |
GET | /v1/clientarea/nav/service | Service categories | profile:read |
POST | /v1/clientarea/search/@query | Search services and products | profile:read |
GET | /v1/clientarea/statuses | List statuses | profile:read |
GET | /v1/contact | List contacts | profile:read |
GET | /v1/contact/@id | Contact details | profile:read |
GET | /v1/contact/privileges | Permissions available for contacts | profile:read |
GET | /v1/contacts | List contacts (contacts) | profile:read |
GET | /v1/details | Account details | profile:read |
GET | /v1/notifications | List notifications | profile:read |
PUT | /v1/notifications/@id/ack | Mark notification as read | profile:write |
GET | /v1/notifications/new | Unread notifications | profile:read |
Domains & DNS
Domains
| Method | Path | Name | Scope |
|---|---|---|---|
GET | /v1/domain | List domains | domains:read |
GET | /v1/domain/@id | Domain details | domains:read |
GET | /v1/domain/@id/autorenew | Get domain auto-renewal | domains:read |
PUT | /v1/domain/@id/autorenew | Turn domain auto-renewal on or off | domains:write |
GET | /v1/domain/@id/contact | Get domain contacts | domains:read |
PUT | /v1/domain/@id/contact | Change domain contacts (registrant) | domains:owner |
GET | /v1/domain/@id/dnssec | List DNSSEC keys | domains:read |
PUT | /v1/domain/@id/dnssec | Add DNSSEC key | domains:write |
DELETE | /v1/domain/@id/dnssec/@key | Delete DNSSEC key | domains:write |
GET | /v1/domain/@id/dnssec/flags | Supported DNSSEC parameters | domains:read |
GET | /v1/domain/@id/emforwarding | Get email forwarding | domains:read |
PUT | /v1/domain/@id/emforwarding | Update email forwarding | domains:write |
GET | /v1/domain/@id/epp | Get domain transfer code (EPP) | domains:owner |
PUT | /v1/domain/@id/forwarding | Update domain forwarding | domains:write |
PUT | /v1/domain/@id/idprotection | Turn registrant privacy on or off | domains:write |
GET | /v1/domain/@id/invoices | Domain invoices | domains:read |
GET | /v1/domain/@id/ns | Get nameservers | domains:read |
PUT | /v1/domain/@id/ns | Change nameservers | domains:write |
GET | /v1/domain/@id/reg | Registered private nameservers | domains:read |
POST | /v1/domain/@id/reg | Manage private nameservers | domains:write |
GET | /v1/domain/@id/reglock | Get domain lock | domains:read |
PUT | /v1/domain/@id/reglock | Turn domain lock on or off | domains:write |
POST | /v1/domain/@id/renew | Renew domain | domains:write |
GET | /v1/domain/@id/sync | Sync domain | domains:write |
POST | /v1/domain/lookup | Check domain availability | domains:read |
GET | /v1/domain/name/@name | Domain details by name | domains:read |
GET | /v1/domain/order | Available domain extensions | domains:read |
POST | /v1/domain/order | Order domain | domains:write |
GET | /v1/domain/order/@id/form | Extra fields per domain extension | domains:read |
GET | /v1/domains | List domains (paginated) | domains:read |
GET | /v1/domains/@id/registrant | Read a waiting domain's registrant | domains:registrant |
PUT | /v1/domains/@id/registrant | Save a waiting domain's registrant | domains:registrant |
GET | /v1/domains/pending | Domains awaiting their dossier | domains:registrant |
GET | /v1/registrants | Registrants used before | domains:registrant |
GET | /v1/whois/@domain | Domain whois lookup (with a token) | domains:read |
GET | /whois/@domain | Domain whois lookup | — |
DNS
| Method | Path | Name | Scope |
|---|---|---|---|
GET | /v1/dns | List DNS zones | dns:read |
GET | /v1/dns/templates | DNS record templates | dns:read |
GET | /v1/domain/@id/dns | Domain DNS records | dns:read |
POST | /v1/domain/@id/dns | Add DNS record to domain | dns:write |
PUT | /v1/domain/@id/dns/@index | Edit domain DNS record | dns:write |
DELETE | /v1/domain/@id/dns/@index | Delete domain DNS record | dns:write |
GET | /v1/domain/@id/dns/types | Supported DNS record types | dns:read |
GET | /v1/service/@service_id/dns | DNS zones of a service | dns:read |
POST | /v1/service/@service_id/dns | Add DNS zone | dns:write |
GET | /v1/service/@service_id/dns/@zone_id | DNS zone details | dns:read |
PUT | /v1/service/@service_id/dns/@zone_id | Edit DNS zone | dns:write |
DELETE | /v1/service/@service_id/dns/@zone_id | Delete DNS zone | dns:write |
GET | /v1/service/@service_id/dns/@zone_id/dnssec | Get DNS zone DNSSEC | dns:read |
PUT | /v1/service/@service_id/dns/@zone_id/dnssec | Turn DNS zone DNSSEC on or off | dns:write |
POST | /v1/service/@service_id/dns/@zone_id/records | Add DNS record | dns:write |
PUT | /v1/service/@service_id/dns/@zone_id/records/@record_id | Edit DNS record | dns:write |
DELETE | /v1/service/@service_id/dns/@zone_id/records/@record_id | Delete DNS record | dns:write |
Cloud & Hosting
Services
| Method | Path | Name | Scope |
|---|---|---|---|
GET | /v1/service | List services | services:read |
GET | /v1/service/@id | Service details | services:read |
POST | /v1/service/@id/cancel | Request service cancellation | services:write |
GET | /v1/service/@id/cycle | Billing cycles | services:read |
POST | /v1/service/@id/cycle | Change billing cycle | services:write |
GET | /v1/service/@id/emails | Hosting email accounts | services:read |
GET | /v1/service/@id/invoices | Service invoices | services:read |
GET | /v1/service/@id/label | Get service label | services:read |
POST | /v1/service/@id/label | Set service label | services:write |
POST | /v1/service/@id/manualrenew | Create service renewal invoice | services:write |
GET | /v1/service/@id/methods | Supported service actions | services:read |
POST | /v1/service/@id/renew | Renew service | services:write |
GET | /v1/service/@id/upgrade | Upgrade options | services:read |
POST | /v1/service/@id/upgrade | Upgrade quote or request | services:write |
GET | /v1/service/@id/widgets | Service widgets | services:read |
GET | /v1/service/cpanel2/@id/statistics | cPanel statistics | services:read |
POST | /v1/service/cpanel2/@id/unblock | Unblock IP on cPanel | services:write |
GET | /v1/services/@cid | Services by category | services:read |
GET | /v1/services/active | Active services | services:read |
VPS servers
| Method | Path | Name | Scope |
|---|---|---|---|
GET | /v1/service/@id/networks | Networks and IP ranges | services:read |
GET | /v1/service/@id/resources | VPS resources | services:read |
GET | /v1/service/@id/templates | OS templates | services:read |
GET | /v1/service/@id/vms | List virtual machines | services:read |
GET | /v1/service/@id/vms/@vmid | Virtual machine details | services:read |
POST | /v1/service/@id/vms/@vmid/hostname | Change VM hostname | services:write |
GET | /v1/service/@id/vms/@vmid/interfaces | VM network interfaces | services:read |
GET | /v1/service/@id/vms/@vmid/interfaces/@iface | Network interface details | services:read |
GET | /v1/service/@id/vms/@vmid/ippool | VM IP pools | services:read |
GET | /v1/service/@id/vms/@vmid/ips | VM IP addresses | services:read |
POST | /v1/service/@id/vms/@vmid/reboot | Restart VM | services:write |
POST | /v1/service/@id/vms/@vmid/reset | Reset VM | services:write |
POST | /v1/service/@id/vms/@vmid/shutdown | Shut down VM | services:write |
POST | /v1/service/@id/vms/@vmid/start | Start VM | services:write |
POST | /v1/service/@id/vms/@vmid/stop | Stop VM | services:write |
GET | /v1/service/@id/vms/@vmid/traffic | VM network traffic | services:read |
SSL certificates
| Method | Path | Name | Scope |
|---|---|---|---|
GET | /v1/certificate | List SSL certificates | services:read |
GET | /v1/certificate/@id | SSL certificate details | services:read |
GET | /v1/certificate/@id/crt | Download certificate | services:read |
GET | /v1/certificate/order | Certificates available to order | services:read |
POST | /v1/certificate/order | Order SSL certificate | services:write |
GET | /v1/certificate/order/@product_id/software | Server software for certificates | services:read |
GET | /v1/certificates | List SSL services (certificates) | services:read |
Billing
Invoices & payments
| Method | Path | Name | Scope |
|---|---|---|---|
GET | /v1/addfunds | Top-up information | billing:read |
POST | /v1/addfunds | Top up | billing:write |
GET | /v1/balance | Account balance | billing:read |
GET | /v1/billing/@invoice_id/pay/@gateway_id | Invoice payment link | billing:write |
POST | /v1/billing/addfunds | Top up (billing) | billing:write |
GET | /v1/billing/creditlogs | Credit balance history | billing:read |
POST | /v1/billing/creditvoucher | Redeem top-up code | billing:write |
GET | /v1/estimate/@id/pdf | Download estimate PDF | billing:read |
GET | /v1/estimates | List estimates | billing:read |
GET | /v1/estimates/@id | Estimate details | billing:read |
GET | /v1/invoice | List invoices | billing:read |
GET | /v1/invoice/@id | Invoice details | billing:read |
DELETE | /v1/invoice/@id | Delete invoice | billing:write |
POST | /v1/invoice/@id/credit | Pay invoice with balance | billing:write |
GET | /v1/invoice/@id/pdf | Download invoice PDF | billing:read |
GET | /v1/invoices | List invoices (paginated) | billing:read |
GET | /v1/invoices/due | Due invoices | billing:read |
POST | /v1/invoices/payall | Pay invoices together | billing:write |
GET | /v1/payment | Payment methods | billing:read |
GET | /v1/payment/fees | Payment method fees | billing:read |
Orders
| Method | Path | Name | Scope |
|---|---|---|---|
POST | /v1/carts | Create a cart | orders:write |
GET | /v1/carts/@uuid | Get a cart | orders:write |
PUT | /v1/carts/@uuid | Update a cart | orders:write |
POST | /v1/carts/@uuid/confirm | Place the order from a cart | orders:write |
GET | /v1/carts/latest | Latest cart | orders:write |
POST | /v1/order | Order several services | orders:write |
POST | /v1/order/@product_id | Order one service | orders:write |
POST | /v1/quote | Get an order quote | orders:write |
TinoPay
Merchant
| Method | Path | Name | Scope |
|---|---|---|---|
GET | /service/@id/tinopay | Merchant details | — |
PATCH | /service/@id/tinopay | Update merchant details | — |
GET | /service/@id/tinopay/pay-codes | Payment code patterns | — |
PUT | /service/@id/tinopay/pay-codes | Save payment code patterns | — |
Bank accounts
| Method | Path | Name | Scope |
|---|---|---|---|
GET | /service/@id/tinopay/bank-accounts | List bank accounts | — |
GET | /service/@id/tinopay/bank-accounts/@bank | Bank account details | — |
POST | /service/@id/tinopay/bank-links/bidv-business | Request a BIDV business link | — |
Virtual accounts
| Method | Path | Name | Scope |
|---|---|---|---|
GET | /service/@id/tinopay/bank-accounts/@bank/virtual-accounts | List virtual accounts (VA) | — |
POST | /service/@id/tinopay/bank-accounts/@bank/virtual-accounts | Create a virtual account | — |
POST | /service/@id/tinopay/bank-accounts/@bank/virtual-accounts/@va/activate | Activate a virtual account | — |
POST | /service/@id/tinopay/bank-accounts/@bank/virtual-accounts/@va/deactivate | Deactivate a virtual account | — |
DELETE | /service/@id/tinopay/bank-accounts/@bank/virtual-accounts/@va | Delete a virtual account | — |
Webhooks
| Method | Path | Name | Scope |
|---|---|---|---|
GET | /service/@id/tinopay/webhooks | List webhooks | — |
POST | /service/@id/tinopay/webhooks | Create a webhook | — |
GET | /service/@id/tinopay/webhooks/@webhook | Webhook details | — |
PATCH | /service/@id/tinopay/webhooks/@webhook | Update a webhook | — |
DELETE | /service/@id/tinopay/webhooks/@webhook | Delete a webhook | — |
GET | /service/@id/tinopay/webhook-logs | Webhook logs | — |
POST | /service/@id/tinopay/webhook-logs/@log/resend | Resend a webhook log | — |
Transactions
| Method | Path | Name | Scope |
|---|---|---|---|
GET | /service/@id/tinopay/transactions | Transaction history | — |
GET | /service/@id/tinopay/transactions/summary | Transaction summary | — |
GET | /service/@id/tinopay/transactions/@transaction | Transaction details | — |
POST | /service/@id/tinopay/transactions/@transaction/resend-webhook | Resend webhooks for a transaction | — |
Notifications
| Method | Path | Name | Scope |
|---|---|---|---|
POST | /service/@id/tinopay/notification-apps/bot-info | Check a bot token | — |
POST | /service/@id/tinopay/notification-apps/find-chats | Find a bot's chats | — |
POST | /service/@id/tinopay/notification-apps/test | Send a test message | — |
GET | /service/@id/tinopay/notification-apps | List notification apps | — |
POST | /service/@id/tinopay/notification-apps | Create a notification app | — |
GET | /service/@id/tinopay/notification-apps/@app | Notification app details | — |
PATCH | /service/@id/tinopay/notification-apps/@app | Update a notification app | — |
DELETE | /service/@id/tinopay/notification-apps/@app | Delete a notification app | — |
Sapo integration
| Method | Path | Name | Scope |
|---|---|---|---|
POST | /service/@id/tinopay/sapo-integrations/test | Test the Sapo connection | — |
GET | /service/@id/tinopay/sapo-integrations | List Sapo integrations | — |
POST | /service/@id/tinopay/sapo-integrations | Create a Sapo integration | — |
GET | /service/@id/tinopay/sapo-integrations/@integration | Get a Sapo integration | — |
PATCH | /service/@id/tinopay/sapo-integrations/@integration | Update a Sapo integration | — |
DELETE | /service/@id/tinopay/sapo-integrations/@integration | Delete a Sapo integration | — |
GET | /service/@id/tinopay/sapo-order-logs | Sapo reconciliation log | — |
API tokens
| Method | Path | Name | Scope |
|---|---|---|---|
GET | /service/@id/tinopay/api-tokens | List API tokens | — |
POST | /service/@id/tinopay/api-tokens | Create an API token | — |
DELETE | /service/@id/tinopay/api-tokens/@token | Revoke an API token | — |
Tino Uptime
Uptime plan
| Method | Path | Name | Scope |
|---|---|---|---|
GET | /service/@id/uptime | Tino Uptime plan overview | — |
GET | /service/@id/uptime/usage | Usage against plan limits | — |
Monitors
| Method | Path | Name | Scope |
|---|---|---|---|
GET | /service/@id/uptime/monitors | List monitors | — |
POST | /service/@id/uptime/monitors | Create a monitor | — |
GET | /service/@id/uptime/monitors/@monitor | Monitor details | — |
PUT | /service/@id/uptime/monitors/@monitor | Update a monitor | — |
DELETE | /service/@id/uptime/monitors/@monitor | Delete a monitor | — |
POST | /service/@id/uptime/monitors/@monitor/pause | Pause a monitor | — |
POST | /service/@id/uptime/monitors/@monitor/resume | Resume a monitor | — |
GET | /service/@id/uptime/monitors/@monitor/uptime | Monitor uptime | — |
GET | /service/@id/uptime/monitors/@monitor/results | Monitor check results | — |
GET | /service/@id/uptime/monitors/@monitor/incidents | Monitor incidents | — |
Incidents
| Method | Path | Name | Scope |
|---|---|---|---|
GET | /service/@id/uptime/incidents | List incidents | — |
GET | /service/@id/uptime/incidents/@incident | Incident details | — |
POST | /service/@id/uptime/incidents/@incident/ack | Acknowledge an incident | — |
Alert channels
| Method | Path | Name | Scope |
|---|---|---|---|
GET | /service/@id/uptime/channels | List alert channels | — |
POST | /service/@id/uptime/channels | Create an alert channel | — |
POST | /service/@id/uptime/channels/@channel/verify | Verify an alert channel | — |
POST | /service/@id/uptime/channels/@channel/test | Send a test message | — |
DELETE | /service/@id/uptime/channels/@channel | Delete an alert channel | — |
TinoPage Builder
Builder account
| Method | Path | Name | Scope |
|---|---|---|---|
GET | /service/@id/builder/overview | TinoPage Builder account overview | — |
POST | /service/@id/builder/login | One-time sign-in ticket | — |
Websites
| Method | Path | Name | Scope |
|---|---|---|---|
GET | /service/@id/builder/sites | List websites | — |
GET | /service/@id/builder/sites/@site | Website details | — |
POST | /service/@id/builder/sites | Create a website with AI | — |
GET | /service/@id/builder/site-creation | Website creation progress | — |
POST | /service/@id/builder/sites/@site/publish | Publish a website | — |
POST | /service/@id/builder/sites/@site/unpublish | Pause a website | — |
DELETE | /service/@id/builder/sites/@site | Delete a website | — |
Custom domains
| Method | Path | Name | Scope |
|---|---|---|---|
GET | /service/@id/builder/sites/@site/domains | Custom domains of a website | — |
POST | /service/@id/builder/sites/@site/domains | Add a custom domain | — |
POST | /service/@id/builder/sites/@site/domains/@hostname/verify | Check DNS again | — |
DELETE | /service/@id/builder/sites/@site/domains/@hostname | Remove a custom domain | — |
Contacts & orders
| Method | Path | Name | Scope |
|---|---|---|---|
GET | /service/@id/builder/sites/@site/leads | Contacts and orders | — |
TinoWAF
TinoWAF
| Method | Path | Name | Scope |
|---|---|---|---|
GET | /v1/service/@id/waf/events | Event summary | waf:read |
GET | /v1/service/@id/waf/ip-rules | List IP rules | waf:read |
POST | /v1/service/@id/waf/ip-rules | Block or allow an IP | waf:write |
DELETE | /v1/service/@id/waf/ip-rules/@rule | Delete an IP rule | waf:write |
POST | /v1/service/@id/waf/ip-rules/apply | Re-apply IP rules | waf:write |
GET | /v1/service/@id/waf/overview | TinoWAF overview | waf:read |
GET | /v1/service/@id/waf/zones | List websites | waf:read |
POST | /v1/service/@id/waf/zones | Add a website | waf:write |
GET | /v1/service/@id/waf/zones/@zone | Get a website | waf:read |
DELETE | /v1/service/@id/waf/zones/@zone | Delete a website | waf:write |
POST | /v1/service/@id/waf/zones/@zone/check | Check DNS now | waf:write |
GET | /v1/service/@id/waf/zones/@zone/events | List a website's events | waf:read |
GET | /v1/service/@id/waf/zones/@zone/hostnames | List a website's domain names | waf:read |
POST | /v1/service/@id/waf/zones/@zone/hostnames | Add a domain name to a website | waf:write |
DELETE | /v1/service/@id/waf/zones/@zone/hostnames/@hostname | Remove a domain name from a website | waf:write |
GET | /v1/service/@id/waf/zones/@zone/origin | Get a website's origin servers | waf:read |
PUT | /v1/service/@id/waf/zones/@zone/origin | Update origin servers | waf:write |
PUT | /v1/service/@id/waf/zones/@zone/under-attack | Turn emergency anti-attack mode on or off | waf:write |
PUT | /v1/service/@id/waf/zones/@zone/waf-mode | Change the protection level | waf:write |
Tickets & support
Tickets & support
| Method | Path | Name | Scope |
|---|---|---|---|
GET | /v1/knowledgebase | Knowledge base categories | tickets:read |
GET | /v1/knowledgebase/@category_id | Articles in a category | tickets:read |
GET | /v1/knowledgebase/article/@article_id | Knowledge base article | tickets:read |
GET | /v1/news | List news | tickets:read |
GET | /v1/news/@news_id | News details | tickets:read |
GET | /v1/ticket/attachment/@file | Download ticket attachment | tickets:read |
GET | /v1/ticket/departments | Support departments | tickets:read |
GET | /v1/tickets | List tickets | tickets:read |
POST | /v1/tickets | Create ticket | tickets:write |
GET | /v1/tickets/@number | Ticket details | tickets:read |
POST | /v1/tickets/@number | Reply to ticket | tickets:write |
PUT | /v1/tickets/@number/close | Close ticket | tickets:write |
PUT | /v1/tickets/@number/open | Reopen ticket | tickets:write |