Referência da API

Todas as operações da API, com filtro, a ligar à página de cada área.

Ver as operaçõesPlayground
Nesta página
  1. Documentação
    2.  » 
  2. Referência da API
Actualizado em 1 min de leitura
Ver em Markdown

Este índice nasce da especificação OpenAPI, a mesma que a API usa. Cada operação leva à página da sua área, onde está explicada e se pode experimentar.

Endereço base

https://api.interweb.ao/v1

Operações

Domínios

GETListar os domínios/v1/domains
GETVer um domínio/v1/domains/{domain}
GETConsultar um nome de domínio/v1/domains/availability
POSTRegistar um domínio/v1/domains/register
POSTTransferir um domínio para nós/v1/domains/transfer
POSTRenovar um domínio/v1/domains/{domain}/renew
GETVer os nameservers/v1/domains/{domain}/nameservers
PUTMudar os nameservers/v1/domains/{domain}/nameservers
GETVer o bloqueio de transferência/v1/domains/{domain}/lock
PUTMudar o bloqueio de transferência/v1/domains/{domain}/lock
PUTMudar a renovação automática/v1/domains/{domain}/auto-renew
GETVer os contactos do domínio/v1/domains/{domain}/contacts
POSTPedir o código de transferência/v1/domains/{domain}/transfer-code

DNS

GETListar os registos DNS/v1/domains/{domain}/dns
POSTAdicionar um registo DNS/v1/domains/{domain}/dns
POSTValidar um registo DNS/v1/domains/{domain}/dns/validate
PUTAlterar um registo DNS/v1/domains/{domain}/dns/{record_id}
DELETEApagar um registo DNS/v1/domains/{domain}/dns/{record_id}
POSTRepor a zona DNS/v1/domains/{domain}/dns/reset
GETListar as cópias da zona/v1/domains/{domain}/dns/backups
POSTRestaurar uma cópia da zona/v1/domains/{domain}/dns/backups/{id}/restore

Hospedagem

GETListar os serviços/v1/services
GETVer um serviço/v1/services/{id}
GETVer o uso de disco, tráfego e recursos/v1/services/{id}/usage
POSTCriar uma ligação de entrada directa/v1/services/{id}/cpanel-login
GETListar subdomínios/v1/services/{id}/subdomains
POSTCriar um subdomínio/v1/services/{id}/subdomains
DELETEApagar um subdomínio/v1/services/{id}/subdomains/{domain}
GETListar domínios adicionais/v1/services/{id}/addon-domains
POSTAdicionar um domínio adicional/v1/services/{id}/addon-domains
DELETERetirar um domínio adicional/v1/services/{id}/addon-domains/{domain}
GETListar redireccionamentos/v1/services/{id}/redirects
POSTCriar um redireccionamento/v1/services/{id}/redirects
DELETEApagar um redireccionamento/v1/services/{id}/redirects/{redirect_id}
GETListar bases de dados/v1/services/{id}/databases
POSTCriar uma base de dados/v1/services/{id}/databases
DELETEApagar uma base de dados/v1/services/{id}/databases/{name}
GETListar utilizadores de bases de dados/v1/services/{id}/database-users
POSTCriar um utilizador de bases de dados/v1/services/{id}/database-users
PUTMudar a senha de um utilizador de bases de dados/v1/services/{id}/database-users/{name}/password
DELETEApagar um utilizador de bases de dados/v1/services/{id}/database-users/{name}
PUTDar a um utilizador acesso a uma base/v1/services/{id}/databases/{name}/users/{user}
DELETERetirar o acesso de um utilizador a uma base/v1/services/{id}/databases/{name}/users/{user}
GETListar tarefas cron/v1/services/{id}/cron
POSTCriar uma tarefa cron/v1/services/{id}/cron
DELETEApagar uma tarefa cron/v1/services/{id}/cron/{cron_id}
GETVer os certificados SSL/v1/services/{id}/ssl
POSTPedir certificados gratuitos/v1/services/{id}/ssl/autossl
GETVer a versão do PHP de cada site/v1/services/{id}/php
GETVer as opções do PHP/v1/services/{id}/php/options
PUTAlterar as opções do PHP/v1/services/{id}/php/options
GETListar as datas das cópias/v1/services/{id}/backups
POSTPedir uma cópia completa/v1/services/{id}/backups
GETListar acessos FTP/v1/services/{id}/ftp-accounts
POSTCriar um acesso FTP/v1/services/{id}/ftp-accounts
PUTMudar a senha de um acesso FTP/v1/services/{id}/ftp-accounts/{login}/password
DELETEApagar um acesso FTP/v1/services/{id}/ftp-accounts/{login}

E-mail

GETListar caixas de e-mail/v1/services/{id}/email/mailboxes
POSTCriar uma caixa de e-mail/v1/services/{id}/email/mailboxes
DELETEApagar uma caixa de e-mail/v1/services/{id}/email/mailboxes/{address}
PUTMudar a senha de uma caixa/v1/services/{id}/email/mailboxes/{address}/password
PUTMudar a quota de uma caixa/v1/services/{id}/email/mailboxes/{address}/quota
GETListar reencaminhadores/v1/services/{id}/email/forwarders
POSTCriar um reencaminhador/v1/services/{id}/email/forwarders
DELETEApagar um reencaminhador/v1/services/{id}/email/forwarders/{address}/{forward_to}
GETListar respostas automáticas/v1/services/{id}/email/autoresponders
GETVer uma resposta automática/v1/services/{id}/email/autoresponders/{address}
PUTGravar uma resposta automática/v1/services/{id}/email/autoresponders/{address}
DELETEApagar uma resposta automática/v1/services/{id}/email/autoresponders/{address}
GETVer a conta geral/v1/services/{id}/email/default-address
PUTAlterar a conta geral/v1/services/{id}/email/default-address
GETVer SPF, DKIM e DMARC/v1/services/{id}/email/authentication

Servidores

GETListar os servidores/v1/servers
GETVer um servidor/v1/servers/{id}
GETVer o tráfego do mês/v1/servers/{id}/traffic
GETListar os sistemas para reinstalar/v1/servers/{id}/operating-systems
GETListar as cópias/v1/servers/{id}/backups
POSTFazer uma cópia/v1/servers/{id}/backups
POSTLigar um servidor/v1/servers/{id}/start
POSTDesligar um servidor/v1/servers/{id}/stop
POSTReiniciar um servidor/v1/servers/{id}/restart
POSTGerar uma nova senha de root/v1/servers/{id}/password
GETVer o DNS reverso/v1/servers/{id}/reverse-dns
PUTMudar o DNS reverso/v1/servers/{id}/reverse-dns
GETVer o fuso horário/v1/servers/{id}/timezone
PUTMudar o fuso horário/v1/servers/{id}/timezone
POSTReinstalar um servidor/v1/servers/{id}/reinstall
POSTRestaurar uma cópia/v1/servers/{id}/restore

SMS

GETListar as mensagens enviadas/v1/sms/messages
POSTEnviar um SMS/v1/sms/messages
GETVer um SMS/v1/sms/messages/{id}
GETVer o saldo de SMS/v1/sms/balance
GETListar os remetentes de SMS/v1/sms/senders
POSTPedir um remetente/v1/sms/senders
GETVer as estatísticas de envio/v1/sms/stats
GETListar os modelos/v1/sms/templates
POSTCriar um modelo/v1/sms/templates
GETVer um modelo/v1/sms/templates/{id}
PATCHAlterar um modelo/v1/sms/templates/{id}
DELETEApagar um modelo/v1/sms/templates/{id}
GETVer um pedido de remetente/v1/sms/senders/{sender}
GETListar os números que não recebem/v1/sms/opt-outs
POSTDeixar de enviar a um número/v1/sms/opt-outs
POSTCancelar um SMS agendado/v1/sms/messages/{id}/cancel

Facturas e saldo

GETListar as facturas/v1/invoices
GETVer uma factura/v1/invoices/{id}
GETVer o saldo/v1/billing/credit
GETListar as transacções/v1/billing/transactions
GETObter o PDF de uma factura/v1/invoices/{id}/pdf
POSTPagar uma factura com saldo/v1/invoices/{id}/pay
GETListar as encomendas/v1/orders
GETVer uma encomenda/v1/orders/{id}
GETListar as cotações/v1/quotes
GETVer uma cotação/v1/quotes/{id}
GETVer os ciclos de renovação de um serviço/v1/services/{id}/billing-cycles
PUTMudar o ciclo da próxima renovação/v1/services/{id}/billing-cycle
GETObter a ligação de upgrade de um serviço/v1/services/{id}/upgrade-link
POSTPedir o cancelamento de um serviço/v1/services/{id}/cancellation

Conta e segurança

GETVer a conta/v1/account
GETListar os contactos/v1/account/contacts
GETListar os utilizadores/v1/account/users

Catálogo

GETListar os produtos/v1/catalog/products
GETListar as extensões de domínio/v1/catalog/tlds
GETListar as moedas/v1/catalog/currencies
GETListar os ciclos de pagamento/v1/catalog/billing-cycles

Suporte

GETListar os tickets/v1/tickets
POSTAbrir um ticket/v1/tickets
GETVer um ticket/v1/tickets/{id}
GETListar os departamentos/v1/support/departments
POSTResponder a um ticket/v1/tickets/{id}/replies
POSTFechar um ticket/v1/tickets/{id}/close
GETListar as categorias da Base de Conhecimento/v1/kb/categories
GETListar ou pesquisar artigos da Base de Conhecimento/v1/kb/articles
GETLer um artigo da Base de Conhecimento/v1/kb/articles/{id}
GETListar os anúncios/v1/announcements
GETLer um anúncio/v1/announcements/{id}

Produtos extra

GETListar os extras à venda/v1/extras/catalog
GETListar os extras da conta/v1/extras
GETVer um extra/v1/extras/{id}
POSTComprar um extra/v1/extras/purchase

Revenda

GETVer os programas de revenda/v1/reseller
GETListar as contas de revenda/v1/reseller/services
GETVer uma conta de revenda/v1/reseller/services/{id}

Chave e estado

GETConfirmar que a API responde/v1/ping
GETVer a chave em uso/v1/token
GETVer os limites da chave/v1/limits
GETAcompanhar uma operação longa/v1/actions/{id}
GETDescarregar esta especificação/v1/openapi.json

Especificação

Descarregar a especificação OpenAPI