Hospedagem

Ver os serviços da conta e gerir uma hospedagem pela API: uso, domínios, bases de dados, cron, SSL, PHP, cópias e FTP.

Ver as operaçõesPlayground
Nesta página
  1. Documentação
    2.  » 
  2. Hospedagem
Actualizado em 9 min de leitura
Ver em Markdown

A API lê os serviços da sua conta e gere as hospedagens activas: tudo corre sempre na conta desse serviço. O que ainda não existe aqui faz-se no My MozOut.

O que precisa

Uma chave com hosting:read para ler e hosting:write para alterar. Têm permissão própria, desligada por omissão, hosting:login para a entrada no cPanel e hosting:code para criar tarefas cron, criar acessos FTP e mudar as suas senhas, porque tudo isso pode correr código na conta. Veja Permissões. Com uma chave sandbox_, ou enquanto a API está em preparação, as alterações são simuladas: a API confere o pedido e não chega ao servidor, por isso o que depende do servidor, como saber se algo já existe, só se confere em Produção. Veja Sandbox e Produção.

A lista de serviços

GET /v1/services devolve todos os serviços da conta, primeiro os mais recentes: hospedagem, servidores e outros produtos. Pode filtrar com status, por exemplo ?status=active. A lista vem em páginas.

curl

curl "https://api.mozout.com/v1/services" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/services", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

O detalhe de um serviço

GET /v1/services/{id} devolve o produto, o endereço, o estado, o ciclo, o valor e a próxima data de pagamento. Nunca devolve senhas.

Enquanto um serviço está por pagar, os campos domain e username podem vir a null.

Quando responde 409

As operações abaixo só correm numa hospedagem activa, num servidor suportado. Caso contrário respondem 409, com a razão em details.reason: not_hosting, service_not_active, server_not_supported ou service_not_ready. Um serviço de outra conta responde 404.

Uso e entrada no painel

GET /v1/services/{id}/usage devolve o disco, o tráfego e os recursos do plano.

POST /v1/services/{id}/cpanel-login cria uma ligação de entrada no cPanel. Só serve uma vez e dá acesso total ao painel, por isso use-a logo e não a guarde em registos.

curl

curl -X POST "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cpanel-login" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Idempotency-Key: 9f1c2d3e-example"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cpanel-login');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Idempotency-Key: 9f1c2d3e-example',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
}
r = requests.post("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cpanel-login", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cpanel-login", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
  },
});
console.log(response.status);
console.log(await response.text());

Domínios e redireccionamentos

As pastas são sempre relativas à pasta da conta, como public_html/blog. Não se aceitam .. nem pastas de sistema. Para apagar um subdomínio ou um domínio adicional, é preciso o nome em confirm; um redireccionamento apaga-se só com o id.

Um domínio adicional, ou a raiz de um subdomínio, tem de estar activo na sua conta: registado connosco (ou subdomínio de um que esteja), ou ser o de uma hospedagem activa. Caso contrário, a resposta é 409 com domain_not_owned. Um domínio registado noutro lado junta-se no cPanel.

curl

curl -X POST "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/subdomains" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"root_domain": "example.co.mz", "name": "blog", "directory": "public_html/blog"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/subdomains');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"root_domain": "example.co.mz", "name": "blog", "directory": "public_html/blog"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Idempotency-Key: 9f1c2d3e-example',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
}
payload = {"root_domain": "example.co.mz", "name": "blog", "directory": "public_html/blog"}
r = requests.post("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/subdomains", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/subdomains", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"root_domain": "example.co.mz", "name": "blog", "directory": "public_html/blog"}),
});
console.log(response.status);
console.log(await response.text());

Bases de dados

Ao criar, o prefixo da conta junta-se sozinho ao nome, se faltar. Nas outras operações, use o nome completo. As senhas têm de 12 a 128 caracteres, com pelo menos 3 tipos entre minúsculas, maiúsculas, números e símbolos, e nunca voltam nas respostas.

Tarefas cron

GET /v1/services/{id}/cron lista as tarefas, com hosting:read, e DELETE /v1/services/{id}/cron/{cron_id} apaga uma, com hosting:write.

O comando de uma tarefa pode ter senhas. Por isso, command só vem preenchido com hosting:code. Sem ela, vem a null e command_hidden a true.

POST /v1/services/{id}/cron cria uma tarefa e precisa de hosting:code. Não se aceitam comandos livres: indique php_script, um ficheiro PHP da conta, ou url, um endereço público que é chamado. Os endereços têm de usar um nome de domínio que resolva para endereços públicos, nunca um IP nem um nome interno, e não podem ter espaços, aspas nem %. O intervalo mínimo é de 5 minutos e cada conta tem até 20 tarefas. Para outros comandos, use o painel.

curl

curl -X POST "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cron" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"schedule": "*/15 * * * *", "php_script": "public_html/cron.php"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cron');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"schedule": "*/15 * * * *", "php_script": "public_html/cron.php"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Idempotency-Key: 9f1c2d3e-example',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
}
payload = {"schedule": "*/15 * * * *", "php_script": "public_html/cron.php"}
r = requests.post("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cron", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cron", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"schedule": "*/15 * * * *", "php_script": "public_html/cron.php"}),
});
console.log(response.status);
console.log(await response.text());

SSL e PHP

Cópias de segurança

GET /v1/services/{id}/backups lista as datas com cópia no servidor. POST /v1/services/{id}/backups pede uma cópia completa, uma vez por dia. Esse ficheiro fica na pasta da conta, ocupa espaço do plano e não entra na lista das datas. Restaurar não se faz pela API.

FTP

GET /v1/services/{id}/ftp-accounts, POST /v1/services/{id}/ftp-accounts, PUT /v1/services/{id}/ftp-accounts/{login}/password e DELETE /v1/services/{id}/ftp-accounts/{login} gerem os acessos, sempre como nome@dominio. Ler precisa de hosting:read e apagar de hosting:write; criar um acesso ou mudar a sua senha precisa de hosting:code. A conta principal não se altera por aqui.

Limites

As alterações têm um limite de 20 por minuto, por hospedagem, e a entrada no painel de 5 por minuto, além do limite geral. As chaves sandbox_ têm estes limites à parte, por isso os pedidos em Sandbox não gastam os de Produção. Se o servidor não responder como esperado, a resposta é 502. Se o pedido já tinha seguido para o servidor, a mesma Idempotency-Key devolve esse 502 sem voltar a executar, porque a alteração pode ter ficado feita: confirme o resultado e, para tentar de novo, use outra chave. Nos pedidos com senha e na entrada no painel, a Idempotency-Key não tem efeito: repetir o pedido volta a executá-lo.

O que ainda não existe

A versão do PHP, os ficheiros, o Git e o Node.js gerem-se no painel; restaurar cópias faz-se no portal ou com o suporte.

Operações

36 operações nesta área. Clique numa operação para ver os parâmetros, os exemplos e as respostas, ou para a experimentar no Playground, sem sair da página.

GET

Listar os serviços

/v1/services
GEThttps://api.mozout.com/v1/services

Precisa de hosting:read. Todos os serviços da conta, primeiro os mais recentes. Enquanto um serviço está por pagar, domain e username podem vir a null.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:read.

Parâmetros

NomeOndeTipoObrigatórioDescrição
statusconsultastring: pending, active, suspended, terminated, cancelled, fraud, completednãoSó os resultados neste estado.
pageconsultaintegernãoO número da página. A primeira é a 1.
per_pageconsultaintegernãoResultados por página, de 1 a 100. Por omissão, 10.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/services" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/services", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Listar os serviços.

{
  "data": [
    {
      "id": 88,
      "product": {
        "id": 12,
        "name": "Plano Empresas",
        "group": "Hospedagem",
        "type": "hostingaccount"
      },
      "domain": "example.co.mz",
      "username": "exemplo88",
      "dedicated_ip": null,
      "status": "active",
      "suspension_reason": null,
      "billing_cycle": "annually",
      "amount": 3600.0,
      "currency": "USD",
      "payment_method": "M-Pesa",
      "registered_at": "2026-02-01",
      "next_due_date": "2027-02-01",
      "terminated_at": null
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

GET

Ver um serviço

/v1/services/{id}
GEThttps://api.mozout.com/v1/services/{id}

Precisa de hosting:read. Nunca devolve senhas.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:read.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Ver um serviço.

{
  "data": {
    "id": 88,
    "product": {
      "id": 12,
      "name": "Plano Empresas",
      "group": "Hospedagem",
      "type": "hostingaccount"
    },
    "domain": "example.co.mz",
    "username": "exemplo88",
    "dedicated_ip": null,
    "status": "active",
    "suspension_reason": null,
    "billing_cycle": "annually",
    "amount": 3600.0,
    "currency": "USD",
    "payment_method": "M-Pesa",
    "registered_at": "2026-02-01",
    "next_due_date": "2027-02-01",
    "terminated_at": null
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

GET

Ver o uso de disco, tráfego e recursos

/v1/services/{id}/usage
GEThttps://api.mozout.com/v1/services/{id}/usage

Precisa de hosting:read. Disco e tráfego em bytes. limit_bytes vem a null quando não há limite. Os itens de resources dependem do servidor. Se o serviço não estiver activo, ou não for uma hospedagem suportada, responde 409 com a razão em details.reason.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:read.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/usage" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/usage');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/usage", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/usage", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Ver o uso de disco, tráfego e recursos.

{
  "data": {
    "disk": {
      "used_bytes": 1048576,
      "limit_bytes": 10737418240
    },
    "bandwidth": {
      "used_bytes": 5242880,
      "limit_bytes": null
    },
    "resources": [
      {
        "id": "email_accounts",
        "used": 2,
        "limit": null
      }
    ]
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

POST

Criar uma ligação de entrada directa

/v1/services/{id}/cpanel-login
POSThttps://api.mozout.com/v1/services/{id}/cpanel-login

Precisa de hosting:login. A ligação só serve uma vez e dá acesso total ao painel desta conta, por isso não a partilhe. A API não a guarda, por isso aqui a Idempotency-Key não tem efeito: repetir o pedido volta a executá-lo: cada pedido cria uma ligação nova. Limite: 5 por minuto. Com uma chave sandbox_, só confere o pedido e não altera nada.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:login.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.
Idempotency-KeycabeçalhostringnãoIdentificador único deste pedido, para o repetir sem o duplicar.

Exemplos

curl

curl -X POST "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cpanel-login" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Idempotency-Key: 9f1c2d3e-example"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cpanel-login');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Idempotency-Key: 9f1c2d3e-example',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
}
r = requests.post("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cpanel-login", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cpanel-login", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

201

Criar uma ligação de entrada directa.

{
  "data": {
    "url": "https://srv.example.com:2083/cpsess0000000000/login/?session=exemplo",
    "single_use": true,
    "simulated": false
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

GET

Listar subdomínios

/v1/services/{id}/subdomains
GEThttps://api.mozout.com/v1/services/{id}/subdomains

Precisa de hosting:read. Cada um com a sua pasta, relativa à pasta da conta. Se o serviço não estiver activo, ou não for uma hospedagem suportada, responde 409 com a razão em details.reason.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:read.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
pageconsultaintegernãoO número da página. A primeira é a 1.
per_pageconsultaintegernãoResultados por página, de 1 a 100. Por omissão, 10.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/subdomains" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/subdomains');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/subdomains", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/subdomains", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Listar subdomínios.

{
  "data": [
    {
      "domain": "blog.example.co.mz",
      "root_domain": "example.co.mz",
      "directory": "public_html/blog"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

POST

Criar um subdomínio

/v1/services/{id}/subdomains
POSThttps://api.mozout.com/v1/services/{id}/subdomains

Precisa de hosting:write. O root_domain tem de estar activo na sua conta: registado connosco (ou subdomínio de um que esteja), ou ser o de uma hospedagem activa; caso contrário responde 409 com domain_not_owned. Um domínio registado noutro lado junta-se no cPanel. O root_domain tem de ser um domínio desta hospedagem. Com uma chave sandbox_, só confere o pedido e não altera nada.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:write.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
Idempotency-KeycabeçalhostringnãoUm valor único qualquer, até 255 caracteres visíveis. Vale 24 horas por chave. Repetir o mesmo pedido devolve a resposta guardada; outro corpo, ou um primeiro pedido ainda em curso, devolve 409.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Corpo do pedido

CampoTipoObrigatórioDescrição
root_domainstringsimUm domínio desta hospedagem.
namestringsimO nome antes do domínio.
directorystringnãoPasta relativa à pasta da conta, sem .. e fora das pastas de sistema.

Exemplos

curl

curl -X POST "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/subdomains" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"root_domain": "example.co.mz", "name": "blog", "directory": "public_html/blog"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/subdomains');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"root_domain": "example.co.mz", "name": "blog", "directory": "public_html/blog"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Idempotency-Key: 9f1c2d3e-example',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
}
payload = {"root_domain": "example.co.mz", "name": "blog", "directory": "public_html/blog"}
r = requests.post("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/subdomains", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/subdomains", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"root_domain": "example.co.mz", "name": "blog", "directory": "public_html/blog"}),
});
console.log(response.status);
console.log(await response.text());

Respostas

201

Criar um subdomínio.

{
  "data": {
    "domain": "blog.example.co.mz",
    "root_domain": "example.co.mz",
    "directory": "public_html/blog",
    "simulated": false
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

DELETE

Apagar um subdomínio

/v1/services/{id}/subdomains/{domain}
DELETEhttps://api.mozout.com/v1/services/{id}/subdomains/{domain}

Precisa de hosting:write. Precisa do nome em confirm. Os ficheiros ficam na pasta. Com uma chave sandbox_, só confere o pedido e não altera nada.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:write.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
domaincaminhostringsimO nome completo do domínio.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Corpo do pedido

CampoTipoObrigatórioDescrição
confirmstringsimO nome exacto do que vai apagar, para confirmar.

Exemplos

curl

curl -X DELETE "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/subdomains/VALUE" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Content-Type: application/json" \
  -d '{"confirm": "blog.example.co.mz"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/subdomains/VALUE');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_POSTFIELDS => '{"confirm": "blog.example.co.mz"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
payload = {"confirm": "blog.example.co.mz"}
r = requests.delete("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/subdomains/VALUE", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/subdomains/VALUE", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"confirm": "blog.example.co.mz"}),
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Apagar um subdomínio.

{
  "data": {
    "domain": "blog.example.co.mz",
    "deleted": true,
    "simulated": false
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

GET

Listar domínios adicionais

/v1/services/{id}/addon-domains
GEThttps://api.mozout.com/v1/services/{id}/addon-domains

Precisa de hosting:read. Os domínios com site próprio nesta conta. Se o serviço não estiver activo, ou não for uma hospedagem suportada, responde 409 com a razão em details.reason.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:read.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
pageconsultaintegernãoO número da página. A primeira é a 1.
per_pageconsultaintegernãoResultados por página, de 1 a 100. Por omissão, 10.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/addon-domains" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/addon-domains');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/addon-domains", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/addon-domains", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Listar domínios adicionais.

{
  "data": [
    {
      "domain": "outro.co.mz",
      "directory": "public_html/outro.co.mz"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

POST

Adicionar um domínio adicional

/v1/services/{id}/addon-domains
POSThttps://api.mozout.com/v1/services/{id}/addon-domains

Precisa de hosting:write. O domínio tem de estar activo na sua conta: registado connosco (ou subdomínio de um que esteja), ou ser o de uma hospedagem activa; caso contrário responde 409 com domain_not_owned. Um domínio registado noutro lado junta-se no cPanel. Conta para o limite de sites do plano. O domínio tem de apontar para os nossos nameservers. Com uma chave sandbox_, só confere o pedido e não altera nada.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:write.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
Idempotency-KeycabeçalhostringnãoUm valor único qualquer, até 255 caracteres visíveis. Vale 24 horas por chave. Repetir o mesmo pedido devolve a resposta guardada; outro corpo, ou um primeiro pedido ainda em curso, devolve 409.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Corpo do pedido

CampoTipoObrigatórioDescrição
domainstringsimO domínio a adicionar.
directorystringnãoPasta relativa à pasta da conta, sem .. e fora das pastas de sistema.

Exemplos

curl

curl -X POST "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/addon-domains" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"domain": "outro.co.mz"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/addon-domains');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"domain": "outro.co.mz"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Idempotency-Key: 9f1c2d3e-example',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
}
payload = {"domain": "outro.co.mz"}
r = requests.post("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/addon-domains", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/addon-domains", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"domain": "outro.co.mz"}),
});
console.log(response.status);
console.log(await response.text());

Respostas

201

Adicionar um domínio adicional.

{
  "data": {
    "domain": "outro.co.mz",
    "directory": "public_html/outro.co.mz",
    "simulated": false
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

DELETE

Retirar um domínio adicional

/v1/services/{id}/addon-domains/{domain}
DELETEhttps://api.mozout.com/v1/services/{id}/addon-domains/{domain}

Precisa de hosting:write. Precisa do nome em confirm. Os ficheiros ficam na pasta. Com uma chave sandbox_, só confere o pedido e não altera nada.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:write.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
domaincaminhostringsimO nome completo do domínio.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Corpo do pedido

CampoTipoObrigatórioDescrição
confirmstringsimO nome exacto do que vai apagar, para confirmar.

Exemplos

curl

curl -X DELETE "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/addon-domains/VALUE" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Content-Type: application/json" \
  -d '{"confirm": "outro.co.mz"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/addon-domains/VALUE');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_POSTFIELDS => '{"confirm": "outro.co.mz"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
payload = {"confirm": "outro.co.mz"}
r = requests.delete("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/addon-domains/VALUE", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/addon-domains/VALUE", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"confirm": "outro.co.mz"}),
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Retirar um domínio adicional.

{
  "data": {
    "domain": "outro.co.mz",
    "deleted": true,
    "simulated": false
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

GET

Listar redireccionamentos

/v1/services/{id}/redirects
GEThttps://api.mozout.com/v1/services/{id}/redirects

Precisa de hosting:read. Um domain igual a all vale para todos os domínios da conta. Se o serviço não estiver activo, ou não for uma hospedagem suportada, responde 409 com a razão em details.reason.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:read.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
pageconsultaintegernãoO número da página. A primeira é a 1.
per_pageconsultaintegernãoResultados por página, de 1 a 100. Por omissão, 10.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/redirects" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/redirects');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/redirects", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/redirects", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Listar redireccionamentos.

{
  "data": [
    {
      "id": "3f2a9c1b7d4e8f60",
      "domain": "example.co.mz",
      "source": "/antigo",
      "destination": "https://www.example.co.mz/novo",
      "type": "permanent",
      "wildcard": false
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

POST

Criar um redireccionamento

/v1/services/{id}/redirects
POSThttps://api.mozout.com/v1/services/{id}/redirects

Precisa de hosting:write. O destination começa por http:// ou https:// e não pode ter espaços, aspas nem %. Com uma chave sandbox_, só confere o pedido e não altera nada.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:write.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
Idempotency-KeycabeçalhostringnãoUm valor único qualquer, até 255 caracteres visíveis. Vale 24 horas por chave. Repetir o mesmo pedido devolve a resposta guardada; outro corpo, ou um primeiro pedido ainda em curso, devolve 409.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Corpo do pedido

CampoTipoObrigatórioDescrição
domainstringsimUm domínio desta hospedagem.
sourcestringnãoCaminho a começar por /. Sem ele, /.
destinationstringsimPara onde vai.
typestringnãopermanent ou temporary.
wildcardbooleannãoMantém o resto do caminho.

Exemplos

curl

curl -X POST "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/redirects" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"domain": "example.co.mz", "source": "/antigo", "destination": "https://www.example.co.mz/novo"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/redirects');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"domain": "example.co.mz", "source": "/antigo", "destination": "https://www.example.co.mz/novo"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Idempotency-Key: 9f1c2d3e-example',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
}
payload = {"domain": "example.co.mz", "source": "/antigo", "destination": "https://www.example.co.mz/novo"}
r = requests.post("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/redirects", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/redirects", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"domain": "example.co.mz", "source": "/antigo", "destination": "https://www.example.co.mz/novo"}),
});
console.log(response.status);
console.log(await response.text());

Respostas

201

Criar um redireccionamento.

{
  "data": {
    "id": "3f2a9c1b7d4e8f60",
    "domain": "example.co.mz",
    "source": "/antigo",
    "destination": "https://www.example.co.mz/novo",
    "type": "permanent",
    "wildcard": false,
    "simulated": false
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

DELETE

Apagar um redireccionamento

/v1/services/{id}/redirects/{redirect_id}
DELETEhttps://api.mozout.com/v1/services/{id}/redirects/{redirect_id}

Precisa de hosting:write. Use o id da lista. Com uma chave sandbox_, só confere o pedido e não altera nada.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:write.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
redirect_idcaminhostringsimO id da lista.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl -X DELETE "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/redirects/VALUE" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/redirects/VALUE');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.delete("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/redirects/VALUE", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/redirects/VALUE", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Apagar um redireccionamento.

{
  "data": {
    "id": "3f2a9c1b7d4e8f60",
    "deleted": true,
    "simulated": false
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

GET

Listar bases de dados

/v1/services/{id}/databases
GEThttps://api.mozout.com/v1/services/{id}/databases

Precisa de hosting:read. Cada uma com o tamanho e os utilizadores. Se o serviço não estiver activo, ou não for uma hospedagem suportada, responde 409 com a razão em details.reason.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:read.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
pageconsultaintegernãoO número da página. A primeira é a 1.
per_pageconsultaintegernãoResultados por página, de 1 a 100. Por omissão, 10.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/databases" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/databases');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/databases", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/databases", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Listar bases de dados.

{
  "data": [
    {
      "name": "conta_site",
      "disk_usage_bytes": 1048576,
      "users": [
        "conta_site"
      ]
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

POST

Criar uma base de dados

/v1/services/{id}/databases
POSThttps://api.mozout.com/v1/services/{id}/databases

Precisa de hosting:write. A resposta traz o nome final, com o prefixo. Com uma chave sandbox_, só confere o pedido e não altera nada.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:write.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
Idempotency-KeycabeçalhostringnãoUm valor único qualquer, até 255 caracteres visíveis. Vale 24 horas por chave. Repetir o mesmo pedido devolve a resposta guardada; outro corpo, ou um primeiro pedido ainda em curso, devolve 409.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Corpo do pedido

CampoTipoObrigatórioDescrição
namestringsimLetras minúsculas, números e _. O prefixo da conta junta-se se faltar.

Exemplos

curl

curl -X POST "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/databases" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"name": "site"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/databases');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"name": "site"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Idempotency-Key: 9f1c2d3e-example',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
}
payload = {"name": "site"}
r = requests.post("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/databases", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/databases", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"name": "site"}),
});
console.log(response.status);
console.log(await response.text());

Respostas

201

Criar uma base de dados.

{
  "data": {
    "name": "conta_site",
    "simulated": false
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

DELETE

Apagar uma base de dados

/v1/services/{id}/databases/{name}
DELETEhttps://api.mozout.com/v1/services/{id}/databases/{name}

Precisa de hosting:write. Precisa do nome em confirm. Os dados perdem-se. Com uma chave sandbox_, só confere o pedido e não altera nada.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:write.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
namecaminhostringsimO nome completo, com o prefixo da conta.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Corpo do pedido

CampoTipoObrigatórioDescrição
confirmstringsimO nome exacto do que vai apagar, para confirmar.

Exemplos

curl

curl -X DELETE "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/databases/VALUE" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Content-Type: application/json" \
  -d '{"confirm": "conta_site"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/databases/VALUE');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_POSTFIELDS => '{"confirm": "conta_site"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
payload = {"confirm": "conta_site"}
r = requests.delete("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/databases/VALUE", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/databases/VALUE", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"confirm": "conta_site"}),
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Apagar uma base de dados.

{
  "data": {
    "name": "conta_site",
    "deleted": true,
    "simulated": false
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

GET

Listar utilizadores de bases de dados

/v1/services/{id}/database-users
GEThttps://api.mozout.com/v1/services/{id}/database-users

Precisa de hosting:read. Cada um com as bases a que tem acesso. Se o serviço não estiver activo, ou não for uma hospedagem suportada, responde 409 com a razão em details.reason.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:read.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
pageconsultaintegernãoO número da página. A primeira é a 1.
per_pageconsultaintegernãoResultados por página, de 1 a 100. Por omissão, 10.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/database-users" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/database-users');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/database-users", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/database-users", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Listar utilizadores de bases de dados.

{
  "data": [
    {
      "name": "conta_site",
      "databases": [
        "conta_site"
      ]
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

POST

Criar um utilizador de bases de dados

/v1/services/{id}/database-users
POSThttps://api.mozout.com/v1/services/{id}/database-users

Precisa de hosting:write. A API nunca guarda a senha, por isso aqui a Idempotency-Key não tem efeito: repetir o pedido volta a executá-lo. Com uma chave sandbox_, só confere o pedido e não altera nada.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:write.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.
Idempotency-KeycabeçalhostringnãoIdentificador único deste pedido, para o repetir sem o duplicar.

Corpo do pedido

CampoTipoObrigatórioDescrição
namestringsimLetras minúsculas, números e _. O prefixo da conta junta-se se faltar.
passwordstringsimDe 12 a 128 caracteres, com pelo menos 3 tipos entre minúsculas, maiúsculas, números e símbolos, sem o nome da conta, nem o do utilizador ou da caixa. Nunca volta.

Exemplos

curl

curl -X POST "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/database-users" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"name": "site", "password": "pP7-kX2mQ9vL4tR8wZ3a"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/database-users');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"name": "site", "password": "pP7-kX2mQ9vL4tR8wZ3a"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Idempotency-Key: 9f1c2d3e-example',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
}
payload = {"name": "site", "password": "pP7-kX2mQ9vL4tR8wZ3a"}
r = requests.post("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/database-users", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/database-users", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"name": "site", "password": "pP7-kX2mQ9vL4tR8wZ3a"}),
});
console.log(response.status);
console.log(await response.text());

Respostas

201

Criar um utilizador de bases de dados.

{
  "data": {
    "name": "conta_site",
    "simulated": false
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

PUT

Mudar a senha de um utilizador de bases de dados

/v1/services/{id}/database-users/{name}/password
PUThttps://api.mozout.com/v1/services/{id}/database-users/{name}/password

Precisa de hosting:write. A senha nunca volta. Com uma chave sandbox_, só confere o pedido e não altera nada.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:write.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
namecaminhostringsimO nome completo, com o prefixo da conta.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Corpo do pedido

CampoTipoObrigatórioDescrição
passwordstringsimDe 12 a 128 caracteres, com pelo menos 3 tipos entre minúsculas, maiúsculas, números e símbolos, sem o nome da conta, nem o do utilizador ou da caixa. Nunca volta.

Exemplos

curl

curl -X PUT "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/database-users/VALUE/password" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Content-Type: application/json" \
  -d '{"password": "pP7-kX2mQ9vL4tR8wZ3a"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/database-users/VALUE/password');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_POSTFIELDS => '{"password": "pP7-kX2mQ9vL4tR8wZ3a"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
payload = {"password": "pP7-kX2mQ9vL4tR8wZ3a"}
r = requests.put("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/database-users/VALUE/password", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/database-users/VALUE/password", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"password": "pP7-kX2mQ9vL4tR8wZ3a"}),
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Mudar a senha de um utilizador de bases de dados.

{
  "data": {
    "name": "conta_site",
    "password_changed": true,
    "simulated": false
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

DELETE

Apagar um utilizador de bases de dados

/v1/services/{id}/database-users/{name}
DELETEhttps://api.mozout.com/v1/services/{id}/database-users/{name}

Precisa de hosting:write. Precisa do nome em confirm. Com uma chave sandbox_, só confere o pedido e não altera nada.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:write.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
namecaminhostringsimO nome completo, com o prefixo da conta.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Corpo do pedido

CampoTipoObrigatórioDescrição
confirmstringsimO nome exacto do que vai apagar, para confirmar.

Exemplos

curl

curl -X DELETE "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/database-users/VALUE" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Content-Type: application/json" \
  -d '{"confirm": "conta_site"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/database-users/VALUE');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_POSTFIELDS => '{"confirm": "conta_site"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
payload = {"confirm": "conta_site"}
r = requests.delete("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/database-users/VALUE", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/database-users/VALUE", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"confirm": "conta_site"}),
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Apagar um utilizador de bases de dados.

{
  "data": {
    "name": "conta_site",
    "deleted": true,
    "simulated": false
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

PUT

Dar a um utilizador acesso a uma base

/v1/services/{id}/databases/{name}/users/{user}
PUThttps://api.mozout.com/v1/services/{id}/databases/{name}/users/{user}

Precisa de hosting:write. Use ALL, ou uma lista como SELECT e INSERT. Com uma chave sandbox_, só confere o pedido e não altera nada.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:write.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
namecaminhostringsimO nome completo, com o prefixo da conta.
usercaminhostringsimO nome completo do utilizador, com o prefixo da conta.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Corpo do pedido

CampoTipoObrigatórioDescrição
privilegesarray<string>nãoSem ele, ALL.

Exemplos

curl

curl -X PUT "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/databases/VALUE/users/VALUE" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Content-Type: application/json" \
  -d '{"privileges": ["ALL"]}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/databases/VALUE/users/VALUE');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_POSTFIELDS => '{"privileges": ["ALL"]}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
payload = {"privileges": ["ALL"]}
r = requests.put("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/databases/VALUE/users/VALUE", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/databases/VALUE/users/VALUE", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"privileges": ["ALL"]}),
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Dar a um utilizador acesso a uma base.

{
  "data": {
    "database": "conta_site",
    "user": "conta_site",
    "privileges": [
      "ALL"
    ],
    "simulated": false
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

DELETE

Retirar o acesso de um utilizador a uma base

/v1/services/{id}/databases/{name}/users/{user}
DELETEhttps://api.mozout.com/v1/services/{id}/databases/{name}/users/{user}

Precisa de hosting:write. O utilizador e a base ficam. Com uma chave sandbox_, só confere o pedido e não altera nada.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:write.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
namecaminhostringsimO nome completo, com o prefixo da conta.
usercaminhostringsimO nome completo do utilizador, com o prefixo da conta.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl -X DELETE "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/databases/VALUE/users/VALUE" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/databases/VALUE/users/VALUE');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.delete("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/databases/VALUE/users/VALUE", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/databases/VALUE/users/VALUE", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Retirar o acesso de um utilizador a uma base.

{
  "data": {
    "database": "conta_site",
    "user": "conta_site",
    "revoked": true,
    "simulated": false
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

GET

Listar tarefas cron

/v1/services/{id}/cron
GEThttps://api.mozout.com/v1/services/{id}/cron

Precisa de hosting:read. Inclui as tarefas criadas no painel. Se o serviço não estiver activo, ou não for uma hospedagem suportada, responde 409 com a razão em details.reason. command pode ter senhas: só vem preenchido com hosting:code; sem ela, vem a null e command_hidden a true.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:read.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
pageconsultaintegernãoO número da página. A primeira é a 1.
per_pageconsultaintegernãoResultados por página, de 1 a 100. Por omissão, 10.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cron" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cron');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cron", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cron", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Listar tarefas cron.

{
  "data": [
    {
      "id": "a1b2c3d4",
      "schedule": "*/15 * * * *",
      "command": null,
      "command_hidden": true
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

POST

Criar uma tarefa cron

/v1/services/{id}/cron
POSThttps://api.mozout.com/v1/services/{id}/cron

Precisa de hosting:code. Uma tarefa cron corre código na conta, por isso esta permissão é separada de hosting:write e fica desligada por omissão. Em url, só se aceitam nomes de domínio públicos, que resolvam para endereços públicos. Não se aceitam comandos livres: indique php_script, um ficheiro PHP da conta, ou url, um endereço público que é chamado. O intervalo mínimo é de 5 minutos e cada conta tem até 20 tarefas. Com uma chave sandbox_, só confere o pedido e não altera nada.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:code.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
Idempotency-KeycabeçalhostringnãoUm valor único qualquer, até 255 caracteres visíveis. Vale 24 horas por chave. Repetir o mesmo pedido devolve a resposta guardada; outro corpo, ou um primeiro pedido ainda em curso, devolve 409.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Corpo do pedido

CampoTipoObrigatórioDescrição
schedulestringsimCinco campos, com números e *, ,, /, -.
php_scriptstringnãoUm ficheiro PHP, relativo à pasta da conta.
urlstringnãoUm endereço público http:// ou https://, sem %.
argsarray<string>nãoAté 8 valores para o script.

Exemplos

curl

curl -X POST "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cron" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"schedule": "*/15 * * * *", "php_script": "public_html/cron.php"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cron');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"schedule": "*/15 * * * *", "php_script": "public_html/cron.php"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Idempotency-Key: 9f1c2d3e-example',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
}
payload = {"schedule": "*/15 * * * *", "php_script": "public_html/cron.php"}
r = requests.post("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cron", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cron", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"schedule": "*/15 * * * *", "php_script": "public_html/cron.php"}),
});
console.log(response.status);
console.log(await response.text());

Respostas

201

Criar uma tarefa cron.

{
  "data": {
    "id": "a1b2c3d4",
    "schedule": "*/15 * * * *",
    "command": "/usr/local/bin/php -q public_html/cron.php >/dev/null 2>&1",
    "simulated": false
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

DELETE

Apagar uma tarefa cron

/v1/services/{id}/cron/{cron_id}
DELETEhttps://api.mozout.com/v1/services/{id}/cron/{cron_id}

Precisa de hosting:write. Use o id da lista. Com uma chave sandbox_, só confere o pedido e não altera nada.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:write.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
cron_idcaminhostringsimO id da lista.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl -X DELETE "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cron/VALUE" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cron/VALUE');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.delete("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cron/VALUE", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/cron/VALUE", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Apagar uma tarefa cron.

{
  "data": {
    "id": "a1b2c3d4",
    "deleted": true,
    "simulated": false
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

GET

Ver os certificados SSL

/v1/services/{id}/ssl
GEThttps://api.mozout.com/v1/services/{id}/ssl

Precisa de hosting:read. O certificado de cada site e a data de fim. meta.autossl_running diz se está a ser pedido um certificado gratuito. Se o serviço não estiver activo, ou não for uma hospedagem suportada, responde 409 com a razão em details.reason.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:read.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
pageconsultaintegernãoO número da página. A primeira é a 1.
per_pageconsultaintegernãoResultados por página, de 1 a 100. Por omissão, 10.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/ssl" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/ssl');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/ssl", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/ssl", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Ver os certificados SSL.

{
  "data": [
    {
      "domain": "example.co.mz",
      "domains": [
        "example.co.mz",
        "www.example.co.mz"
      ],
      "expires_at": "2027-02-01T10:00:00+02:00",
      "self_signed": false,
      "validation_type": "dv"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1,
    "autossl_running": false
  }
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

POST

Pedir certificados gratuitos

/v1/services/{id}/ssl/autossl
POSThttps://api.mozout.com/v1/services/{id}/ssl/autossl

Precisa de hosting:write. Só resulta nos domínios que apontam para os nossos servidores. Limite: uma vez a cada 15 minutos por hospedagem. Com uma chave sandbox_, só confere o pedido e não altera nada.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:write.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
Idempotency-KeycabeçalhostringnãoUm valor único qualquer, até 255 caracteres visíveis. Vale 24 horas por chave. Repetir o mesmo pedido devolve a resposta guardada; outro corpo, ou um primeiro pedido ainda em curso, devolve 409.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl -X POST "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/ssl/autossl" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Idempotency-Key: 9f1c2d3e-example"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/ssl/autossl');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Idempotency-Key: 9f1c2d3e-example',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
}
r = requests.post("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/ssl/autossl", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/ssl/autossl", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

202

Pedir certificados gratuitos.

{
  "data": {
    "requested": true,
    "action_id": "6f1d2c3a-8b4e-4f7a-9c21-1d2e3f4a5b6c",
    "simulated": false
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

GET

Ver a versão do PHP de cada site

/v1/services/{id}/php
GEThttps://api.mozout.com/v1/services/{id}/php

Precisa de hosting:read. A versão de cada domínio, ou inherit. Para mudar a versão, use o painel. Se o serviço não estiver activo, ou não for uma hospedagem suportada, responde 409 com a razão em details.reason.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:read.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
pageconsultaintegernãoO número da página. A primeira é a 1.
per_pageconsultaintegernãoResultados por página, de 1 a 100. Por omissão, 10.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/php" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/php');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/php", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/php", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Ver a versão do PHP de cada site.

{
  "data": [
    {
      "domain": "example.co.mz",
      "version": "8.2"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1,
    "available_versions": [
      "7.4",
      "8.2"
    ]
  }
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

GET

Ver as opções do PHP

/v1/services/{id}/php/options
GEThttps://api.mozout.com/v1/services/{id}/php/options

Precisa de hosting:read. Só as opções que se podem alterar pela API. Se o serviço não estiver activo, ou não for uma hospedagem suportada, responde 409 com a razão em details.reason.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:read.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
domainconsultastringnãoUm domínio desta hospedagem. Sem ele, o domínio principal.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/php/options" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/php/options');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/php/options", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/php/options", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Ver as opções do PHP.

{
  "data": {
    "domain": "example.co.mz",
    "options": {
      "memory_limit": "256M",
      "max_execution_time": "60"
    }
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

PUT

Alterar as opções do PHP

/v1/services/{id}/php/options
PUThttps://api.mozout.com/v1/services/{id}/php/options

Precisa de hosting:write. Aceites: memory_limit (32M a 2048M), post_max_size e upload_max_filesize (1M a 2048M), max_execution_time e max_input_time (1 a 600), max_input_vars (100 a 20000), session.gc_maxlifetime (60 a 86400), display_errors e zlib.output_compression (true ou false). Com uma chave sandbox_, só confere o pedido e não altera nada.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:write.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Corpo do pedido

CampoTipoObrigatórioDescrição
domainstringsimUm domínio desta hospedagem.
optionsobjectsimAs opções a alterar.

Exemplos

curl

curl -X PUT "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/php/options" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Content-Type: application/json" \
  -d '{"domain": "example.co.mz", "options": {"memory_limit": "256M", "max_execution_time": 60}}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/php/options');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_POSTFIELDS => '{"domain": "example.co.mz", "options": {"memory_limit": "256M", "max_execution_time": 60}}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
payload = {"domain": "example.co.mz", "options": {"memory_limit": "256M", "max_execution_time": 60}}
r = requests.put("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/php/options", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/php/options", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"domain": "example.co.mz", "options": {"memory_limit": "256M", "max_execution_time": 60}}),
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Alterar as opções do PHP.

{
  "data": {
    "domain": "example.co.mz",
    "options": {
      "memory_limit": "256M"
    },
    "simulated": false
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

GET

Listar as datas das cópias

/v1/services/{id}/backups
GEThttps://api.mozout.com/v1/services/{id}/backups

Precisa de hosting:read. As datas com cópia no servidor. A cópia pedida com POST fica na pasta da conta e não entra nesta lista. Para restaurar, use o portal ou fale com o suporte. Se o serviço não estiver activo, ou não for uma hospedagem suportada, responde 409 com a razão em details.reason.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:read.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
pageconsultaintegernãoO número da página. A primeira é a 1.
per_pageconsultaintegernãoResultados por página, de 1 a 100. Por omissão, 10.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/backups" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/backups');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/backups", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/backups", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Listar as datas das cópias.

{
  "data": [
    {
      "date": "2026-11-01"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

POST

Pedir uma cópia completa

/v1/services/{id}/backups
POSThttps://api.mozout.com/v1/services/{id}/backups

Precisa de hosting:write. O ficheiro fica na pasta da conta e ocupa espaço do plano. Limite: uma vez por dia por hospedagem. Com uma chave sandbox_, só confere o pedido e não altera nada.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:write.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
Idempotency-KeycabeçalhostringnãoUm valor único qualquer, até 255 caracteres visíveis. Vale 24 horas por chave. Repetir o mesmo pedido devolve a resposta guardada; outro corpo, ou um primeiro pedido ainda em curso, devolve 409.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl -X POST "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/backups" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Idempotency-Key: 9f1c2d3e-example"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/backups');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Idempotency-Key: 9f1c2d3e-example',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
}
r = requests.post("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/backups", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/backups", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

202

Pedir uma cópia completa.

{
  "data": {
    "requested": true,
    "action_id": "6f1d2c3a-8b4e-4f7a-9c21-1d2e3f4a5b6c",
    "simulated": false
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

GET

Listar acessos FTP

/v1/services/{id}/ftp-accounts
GEThttps://api.mozout.com/v1/services/{id}/ftp-accounts

Precisa de hosting:read. quota_mb vem a null quando não há limite. Se o serviço não estiver activo, ou não for uma hospedagem suportada, responde 409 com a razão em details.reason.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:read.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
pageconsultaintegernãoO número da página. A primeira é a 1.
per_pageconsultaintegernãoResultados por página, de 1 a 100. Por omissão, 10.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Listar acessos FTP.

{
  "data": [
    {
      "login": "[email protected]",
      "type": "sub",
      "directory": "public_html/ana",
      "used_mb": 1.5,
      "quota_mb": 1024
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

POST

Criar um acesso FTP

/v1/services/{id}/ftp-accounts
POSThttps://api.mozout.com/v1/services/{id}/ftp-accounts

Precisa de hosting:code. O FTP na pasta do site pode correr código na conta, por isso esta permissão é separada de hosting:write e fica desligada por omissão. O acesso só vê a sua pasta. A API nunca guarda a senha, por isso aqui a Idempotency-Key não tem efeito: repetir o pedido volta a executá-lo. Com uma chave sandbox_, só confere o pedido e não altera nada.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:code.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.
Idempotency-KeycabeçalhostringnãoIdentificador único deste pedido, para o repetir sem o duplicar.

Corpo do pedido

CampoTipoObrigatórioDescrição
userstringsimO nome antes do domínio.
domainstringsimUm domínio desta hospedagem.
passwordstringsimDe 12 a 128 caracteres, com pelo menos 3 tipos entre minúsculas, maiúsculas, números e símbolos, sem o nome da conta, nem o do utilizador ou da caixa. Nunca volta.
directorystringsimPasta relativa à pasta da conta, sem .. e fora das pastas de sistema.
quota_mbintegernãoDe 1 a 102400. Sem ele, 1024.

Exemplos

curl

curl -X POST "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"user": "ana", "domain": "example.co.mz", "password": "pP7-kX2mQ9vL4tR8wZ3a", "directory": "public_html/ana"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"user": "ana", "domain": "example.co.mz", "password": "pP7-kX2mQ9vL4tR8wZ3a", "directory": "public_html/ana"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Idempotency-Key: 9f1c2d3e-example',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
}
payload = {"user": "ana", "domain": "example.co.mz", "password": "pP7-kX2mQ9vL4tR8wZ3a", "directory": "public_html/ana"}
r = requests.post("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"user": "ana", "domain": "example.co.mz", "password": "pP7-kX2mQ9vL4tR8wZ3a", "directory": "public_html/ana"}),
});
console.log(response.status);
console.log(await response.text());

Respostas

201

Criar um acesso FTP.

{
  "data": {
    "login": "[email protected]",
    "directory": "public_html/ana",
    "quota_mb": 1024,
    "simulated": false
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

PUT

Mudar a senha de um acesso FTP

/v1/services/{id}/ftp-accounts/{login}/password
PUThttps://api.mozout.com/v1/services/{id}/ftp-accounts/{login}/password

Precisa de hosting:code. O FTP na pasta do site pode correr código na conta, por isso esta permissão é separada de hosting:write e fica desligada por omissão. A conta principal não se altera por aqui. Com uma chave sandbox_, só confere o pedido e não altera nada.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:code.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
logincaminhostringsimO acesso, como nome@dominio.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Corpo do pedido

CampoTipoObrigatórioDescrição
passwordstringsimDe 12 a 128 caracteres, com pelo menos 3 tipos entre minúsculas, maiúsculas, números e símbolos, sem o nome da conta, nem o do utilizador ou da caixa. Nunca volta.

Exemplos

curl

curl -X PUT "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts/VALUE/password" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Content-Type: application/json" \
  -d '{"password": "pP7-kX2mQ9vL4tR8wZ3a"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts/VALUE/password');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_POSTFIELDS => '{"password": "pP7-kX2mQ9vL4tR8wZ3a"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
payload = {"password": "pP7-kX2mQ9vL4tR8wZ3a"}
r = requests.put("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts/VALUE/password", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts/VALUE/password", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"password": "pP7-kX2mQ9vL4tR8wZ3a"}),
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Mudar a senha de um acesso FTP.

{
  "data": {
    "login": "[email protected]",
    "password_changed": true,
    "simulated": false
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.

DELETE

Apagar um acesso FTP

/v1/services/{id}/ftp-accounts/{login}
DELETEhttps://api.mozout.com/v1/services/{id}/ftp-accounts/{login}

Precisa de hosting:write. Precisa do acesso em confirm. Os ficheiros ficam. A conta principal não se apaga. Com uma chave sandbox_, só confere o pedido e não altera nada.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: hosting:write.

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do serviço de hospedagem.
logincaminhostringsimO acesso, como nome@dominio.
X-API-Modecabeçalhostring: sandbox, productionnãoOpcional. Se não coincidir com o modo da chave, o pedido é recusado com invalid_request e a razão mode_mismatch. Serve para garantir que um programa nunca corre com a chave errada.

Corpo do pedido

CampoTipoObrigatórioDescrição
confirmstringsimO nome exacto do que vai apagar, para confirmar.

Exemplos

curl

curl -X DELETE "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts/VALUE" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Content-Type: application/json" \
  -d '{"confirm": "[email protected]"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts/VALUE');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_POSTFIELDS => '{"confirm": "[email protected]"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
payload = {"confirm": "[email protected]"}
r = requests.delete("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts/VALUE", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/ftp-accounts/VALUE", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"confirm": "[email protected]"}),
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Apagar um acesso FTP.

{
  "data": {
    "login": "[email protected]",
    "deleted": true,
    "simulated": false
  },
  "meta": {}
}
CabeçalhoDescrição
X-Correlation-IDIdentificador deste pedido. Indique-o ao suporte se comunicar um problema.
X-RateLimit-LimitPedidos permitidos por minuto.
X-RateLimit-RemainingPedidos que restam no minuto actual.
X-RateLimit-ResetQuando acaba o minuto, em segundos Unix.
X-API-ModeO modo da chave que fez o pedido: sandbox ou production.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}
CabeçalhoDescrição
Retry-AfterSegundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

EstadoCódigoSignificado
401unauthorizedA chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403forbidden, insufficient_scope, ip_not_allowedA conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).
404not_foundNão encontrado.
409conflictA operação não se pode fazer no estado actual. Veja details.reason.
422validation_failedAlguns dados não são válidos.
429rate_limitedDemasiados pedidos. Espere o tempo indicado em Retry-After.
500internal_errorOcorreu um erro interno. Indique o correlation_id ao suporte.
502upstream_errorO serviço por trás da API não respondeu como esperado.
503disabledA API está desligada.

O formato dos erros está explicado em Erros.