API reference

Every API operation, with a filter, linking to the page of each area.

See the operationsPlayground
On this page
  1. Documentation
    2.  » 
  2. API reference
Updated on 1 min read
View as Markdown

This index comes from the OpenAPI specification, the same one the API uses. Each operation leads to the page of its area, where it is explained and can be tried.

Base address

https://api.interweb.ao/v1

Operations

Domains

GETList the domains/v1/domains
GETSee a domain/v1/domains/{domain}
GETCheck a domain name/v1/domains/availability
POSTRegister a domain/v1/domains/register
POSTTransfer a domain to us/v1/domains/transfer
POSTRenew a domain/v1/domains/{domain}/renew
GETSee the nameservers/v1/domains/{domain}/nameservers
PUTChange the nameservers/v1/domains/{domain}/nameservers
GETSee the transfer lock/v1/domains/{domain}/lock
PUTChange the transfer lock/v1/domains/{domain}/lock
PUTChange auto-renewal/v1/domains/{domain}/auto-renew
GETSee the domain contacts/v1/domains/{domain}/contacts
POSTRequest the transfer code/v1/domains/{domain}/transfer-code

DNS

GETList the DNS records/v1/domains/{domain}/dns
POSTAdd a DNS record/v1/domains/{domain}/dns
POSTCheck a DNS record/v1/domains/{domain}/dns/validate
PUTChange a DNS record/v1/domains/{domain}/dns/{record_id}
DELETEDelete a DNS record/v1/domains/{domain}/dns/{record_id}
POSTReset the DNS zone/v1/domains/{domain}/dns/reset
GETList the zone backups/v1/domains/{domain}/dns/backups
POSTRestore a zone backup/v1/domains/{domain}/dns/backups/{id}/restore

Hosting

GETList the services/v1/services
GETSee a service/v1/services/{id}
GETSee disk, traffic and resource usage/v1/services/{id}/usage
POSTCreate a direct login link/v1/services/{id}/cpanel-login
GETList subdomains/v1/services/{id}/subdomains
POSTCreate a subdomain/v1/services/{id}/subdomains
DELETEDelete a subdomain/v1/services/{id}/subdomains/{domain}
GETList addon domains/v1/services/{id}/addon-domains
POSTAdd an addon domain/v1/services/{id}/addon-domains
DELETERemove an addon domain/v1/services/{id}/addon-domains/{domain}
GETList redirects/v1/services/{id}/redirects
POSTCreate a redirect/v1/services/{id}/redirects
DELETEDelete a redirect/v1/services/{id}/redirects/{redirect_id}
GETList databases/v1/services/{id}/databases
POSTCreate a database/v1/services/{id}/databases
DELETEDelete a database/v1/services/{id}/databases/{name}
GETList database users/v1/services/{id}/database-users
POSTCreate a database user/v1/services/{id}/database-users
PUTChange a database user password/v1/services/{id}/database-users/{name}/password
DELETEDelete a database user/v1/services/{id}/database-users/{name}
PUTGive a user access to a database/v1/services/{id}/databases/{name}/users/{user}
DELETERemove a user access to a database/v1/services/{id}/databases/{name}/users/{user}
GETList cron jobs/v1/services/{id}/cron
POSTCreate a cron job/v1/services/{id}/cron
DELETEDelete a cron job/v1/services/{id}/cron/{cron_id}
GETSee the SSL certificates/v1/services/{id}/ssl
POSTRequest free certificates/v1/services/{id}/ssl/autossl
GETSee the PHP version of each site/v1/services/{id}/php
GETSee the PHP options/v1/services/{id}/php/options
PUTChange the PHP options/v1/services/{id}/php/options
GETList backup dates/v1/services/{id}/backups
POSTRequest a full backup/v1/services/{id}/backups
GETList FTP accounts/v1/services/{id}/ftp-accounts
POSTCreate an FTP account/v1/services/{id}/ftp-accounts
PUTChange an FTP password/v1/services/{id}/ftp-accounts/{login}/password
DELETEDelete an FTP account/v1/services/{id}/ftp-accounts/{login}

Email

GETList mailboxes/v1/services/{id}/email/mailboxes
POSTCreate a mailbox/v1/services/{id}/email/mailboxes
DELETEDelete a mailbox/v1/services/{id}/email/mailboxes/{address}
PUTChange a mailbox password/v1/services/{id}/email/mailboxes/{address}/password
PUTChange a mailbox quota/v1/services/{id}/email/mailboxes/{address}/quota
GETList forwarders/v1/services/{id}/email/forwarders
POSTCreate a forwarder/v1/services/{id}/email/forwarders
DELETEDelete a forwarder/v1/services/{id}/email/forwarders/{address}/{forward_to}
GETList autoresponders/v1/services/{id}/email/autoresponders
GETSee an autoresponder/v1/services/{id}/email/autoresponders/{address}
PUTSave an autoresponder/v1/services/{id}/email/autoresponders/{address}
DELETEDelete an autoresponder/v1/services/{id}/email/autoresponders/{address}
GETSee the default address/v1/services/{id}/email/default-address
PUTChange the default address/v1/services/{id}/email/default-address
GETSee SPF, DKIM and DMARC/v1/services/{id}/email/authentication

Servers

GETList the servers/v1/servers
GETSee a server/v1/servers/{id}
GETSee the traffic of the month/v1/servers/{id}/traffic
GETList the systems to reinstall/v1/servers/{id}/operating-systems
GETList the backups/v1/servers/{id}/backups
POSTMake a backup/v1/servers/{id}/backups
POSTStart a server/v1/servers/{id}/start
POSTStop a server/v1/servers/{id}/stop
POSTRestart a server/v1/servers/{id}/restart
POSTGenerate a new root password/v1/servers/{id}/password
GETSee the reverse DNS/v1/servers/{id}/reverse-dns
PUTChange the reverse DNS/v1/servers/{id}/reverse-dns
GETSee the time zone/v1/servers/{id}/timezone
PUTChange the time zone/v1/servers/{id}/timezone
POSTReinstall a server/v1/servers/{id}/reinstall
POSTRestore a backup/v1/servers/{id}/restore

SMS

GETList sent messages/v1/sms/messages
POSTSend an SMS/v1/sms/messages
GETSee one SMS/v1/sms/messages/{id}
GETSee the SMS balance/v1/sms/balance
GETList the SMS senders/v1/sms/senders
POSTRequest a sender/v1/sms/senders
GETSee sending statistics/v1/sms/stats
GETList templates/v1/sms/templates
POSTCreate a template/v1/sms/templates
GETSee a template/v1/sms/templates/{id}
PATCHChange a template/v1/sms/templates/{id}
DELETEDelete a template/v1/sms/templates/{id}
GETSee a sender request/v1/sms/senders/{sender}
GETList numbers that do not receive/v1/sms/opt-outs
POSTStop sending to a number/v1/sms/opt-outs
POSTCancel a scheduled SMS/v1/sms/messages/{id}/cancel

Invoices and credit

GETList the invoices/v1/invoices
GETSee an invoice/v1/invoices/{id}
GETSee the credit/v1/billing/credit
GETList the transactions/v1/billing/transactions
GETGet the PDF of an invoice/v1/invoices/{id}/pdf
POSTPay an invoice with credit/v1/invoices/{id}/pay
GETList the orders/v1/orders
GETSee an order/v1/orders/{id}
GETList the quotes/v1/quotes
GETSee a quote/v1/quotes/{id}
GETSee the renewal cycles of a service/v1/services/{id}/billing-cycles
PUTChange the cycle of the next renewal/v1/services/{id}/billing-cycle
GETGet the upgrade link of a service/v1/services/{id}/upgrade-link
POSTRequest the cancellation of a service/v1/services/{id}/cancellation

Account and security

GETSee the account/v1/account
GETList the contacts/v1/account/contacts
GETList the users/v1/account/users

Catalog

GETList the products/v1/catalog/products
GETList the domain extensions/v1/catalog/tlds
GETList the currencies/v1/catalog/currencies
GETList the billing cycles/v1/catalog/billing-cycles

Support

GETList the tickets/v1/tickets
POSTOpen a ticket/v1/tickets
GETSee a ticket/v1/tickets/{id}
GETList the departments/v1/support/departments
POSTReply to a ticket/v1/tickets/{id}/replies
POSTClose a ticket/v1/tickets/{id}/close
GETList the Knowledge Base categories/v1/kb/categories
GETList or search Knowledge Base articles/v1/kb/articles
GETRead a Knowledge Base article/v1/kb/articles/{id}
GETList the announcements/v1/announcements
GETRead an announcement/v1/announcements/{id}

Extra products

GETList extras for sale/v1/extras/catalog
GETList the extras of the account/v1/extras
GETSee an extra/v1/extras/{id}
POSTBuy an extra/v1/extras/purchase

Reseller

GETSee the reseller programs/v1/reseller
GETList reseller accounts/v1/reseller/services
GETSee a reseller account/v1/reseller/services/{id}

Key and status

GETCheck that the API is responding/v1/ping
GETSee the key in use/v1/token
GETSee the limits of the key/v1/limits
GETFollow a long-running operation/v1/actions/{id}
GETDownload this specification/v1/openapi.json

Specification

Download the OpenAPI specification