Servidores

Ver o estado, ligar, desligar, reiniciar, mudar a senha e reinstalar os seus servidores VPS pela API.

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

Com uma chave sandbox_, ou enquanto a API está em preparação, as alterações são simuladas e nenhum servidor é tocado. Veja Sandbox e Produção.

Que servidores aparecem

Só os servidores activos ou suspensos da conta geridos pelo painel do My MozOut. Um servidor por criar, terminado ou cancelado responde 404. O id de um servidor é o mesmo do seu serviço em GET /v1/services. Com o serviço suspenso, os dados lêem-se mas as acções respondem 409 com service_not_active.

Detalhes e estado

GET /v1/servers lista os servidores, em páginas. GET /v1/servers/{id} mostra o detalhe: IP, sistema, recursos e power_state. Precisam de vps:read.

curl

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

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/servers');
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/servers", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

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

O estado vem de uma cópia recente, porque não perguntamos ao servidor em cada pedido. state_checked_at diz quando foi lido. O detalhe usa uma cópia com até 60 segundos; a lista só actualiza 2 servidores de cada vez, e os outros mostram o que já se sabe. Se não for possível ler agora, o detalhe traz state_stale a true com o último estado conhecido.

Também pode ver o tráfego do mês, as cópias, o DNS reverso, o fuso horário e os sistemas disponíveis.

Ligar, desligar e reiniciar

Precisam de vps:write. As acções entram em fila e respondem 202 com action_id. Ligar costuma demorar cerca de 2 minutos e desligar cerca de 6.

curl

curl -X POST "https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/restart" \
  -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/servers/00000000-0000-4000-8000-000000000000/restart');
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/servers/00000000-0000-4000-8000-000000000000/restart", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/restart", {
  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());

Acompanhar uma acção

Veja o estado em GET /v1/actions/{id}: running enquanto corre, depois done ou failed. Se passar o tempo sem confirmação, fica failed com timed_out em result.reason: veja nesse caso o estado do servidor. Se o servidor deixar de estar disponível, fica failed com server_gone. Só a chave que pediu a acção a pode consultar. O estado vem de uma cópia com até 20 segundos e conta para o limite de leituras da conta: passado esse limite, a acção continua running até à leitura seguinte.

Um de cada vez

Cada servidor faz uma acção de cada vez. Com outra em curso, a resposta é 409 com action_in_progress e o action_id em details. Há ainda estes limites, e o excesso responde 429 com Retry-After:

  • 15 segundos entre acções no mesmo servidor.
  • 10 acções por minuto em toda a conta.
  • 5 senhas novas por hora, em toda a conta.
  • 3 reinstalações ou restauros por hora, em toda a conta.

As chaves sandbox_ têm estes limites à parte, por isso os pedidos em Sandbox não gastam os de Produção.

Senha de root

POST /v1/servers/{id}/password gera uma senha nova. Precisa de vps:password e do nome do servidor em confirm. É uma permissão própria, desligada por omissão, porque a resposta traz a senha de root: vps:write não chega. O servidor reinicia para a aplicar, e a senha funciona ao fim de 1 a 2 minutos.

A senha aparece só nessa resposta: guarde-a logo. Repetir com a mesma Idempotency-Key não gera outra e devolve password a null. Em Sandbox a senha não é verdadeira.

Cópias

POST /v1/servers/{id}/backups faz uma cópia, que pode demorar até 50 minutos a aparecer. Cada servidor tem no máximo 4 cópias, contando as automáticas. Com 4 cópias a resposta é 409 com backup_limit_reached. Descarregar e apagar cópias faz-se no My MozOut.

DNS reverso e fuso horário

PUT /v1/servers/{id}/reverse-dns muda o nome de cada IP do servidor. PUT /v1/servers/{id}/timezone muda o fuso, escolhido da lista. Precisam de vps:write. Só se aceitam os IP do servidor: se não for possível ler a lista deles, a resposta é 502 e nada muda. Enquanto o nome for o de origem, hostname vem a null.

Reinstalar e restaurar

Estas duas apagam dados, por isso têm permissões próprias, desligadas por omissão. Precisam também do cabeçalho Idempotency-Key e do nome do servidor em confirm.

  • POST /v1/servers/{id}/reinstall, com vps:reinstall, apaga tudo e instala o sistema escolhido em operating_system. Em backup_first diz se quer uma cópia antes: com true, a reinstalação começa sozinha quando a cópia aparecer, o que pode demorar até uma hora. A nova senha de root aparece só nessa resposta.
  • POST /v1/servers/{id}/restore, com vps:restore, faz o servidor voltar ao estado da cópia indicada em backup, e tudo o que mudou depois dela perde-se.

Comprar IP ou disco extra, a consola e o CD virtual fazem-se no My MozOut.

Ajuda

Para saber mais sobre servidores, veja a Base de Conhecimento.

Operações

16 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 servidores

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

Precisa de vps:read. Os servidores activos e suspensos da conta, primeiro os mais recentes. O estado vem de uma cópia recente; state_checked_at diz quando foi lido, e é null se ainda não foi lido. Os estados de power_state são running, stopped, starting, stopping, restarting, reinstalling, backing_up e unknown.

Autenticação

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

Parâmetros

NomeOndeTipoObrigatórioDescrição
statusconsultastringnãoFiltra por active ou suspended.
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/servers" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/servers');
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/servers", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

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

Respostas

200

Listar os servidores.

{
  "data": [
    {
      "id": 700,
      "name": "web1.example.co.mz",
      "status": "active",
      "product": "VPS 1",
      "ip": "203.0.113.10",
      "power_state": "running",
      "state_checked_at": "2026-11-05T09:00:00+02:00",
      "next_due_date": "2026-12-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"
    }
  }
}

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 servidor

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

Precisa de vps:read. O estado vem de uma cópia com até 60 segundos. Se não for possível ler agora, state_stale é true e mostra-se o último estado conhecido. Os estados de power_state são running, stopped, starting, stopping, restarting, reinstalling, backing_up e unknown.

Autenticação

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

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do servidor, o mesmo do seu 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/servers/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/servers/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/servers/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/servers/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 servidor.

{
  "data": {
    "id": 700,
    "name": "web1.example.co.mz",
    "status": "active",
    "product": "VPS 1",
    "ip": "203.0.113.10",
    "power_state": "running",
    "state_checked_at": "2026-11-05T09:00:00+02:00",
    "next_due_date": "2026-12-01",
    "additional_ips": [
      "203.0.113.11"
    ],
    "operating_system": {
      "name": "Ubuntu",
      "version": "24.04"
    },
    "location": "New Jersey, USA",
    "resources": {
      "vcpu": 2,
      "ram_gb": 4,
      "disk_gb": 80,
      "traffic_gb": 4000
    },
    "billing_cycle": "monthly",
    "state_stale": false,
    "portal_url": "https://portal.example.co.mz/clientarea.php?action=productdetails&id=700&language=english&currency=1"
  },
  "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": {}
  }
}

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.
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 o tráfego do mês

/v1/servers/{id}/traffic
GEThttps://api.mozout.com/v1/servers/{id}/traffic

Precisa de vps:read. O tráfego deste mês, por dia e no total, em GB. Vem de uma cópia com até 5 minutos.

Autenticação

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

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do servidor, o mesmo do seu 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/servers/00000000-0000-4000-8000-000000000000/traffic" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/traffic');
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/servers/00000000-0000-4000-8000-000000000000/traffic", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

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

Respostas

200

Ver o tráfego do mês.

{
  "data": {
    "server_id": 700,
    "month": "2026-11",
    "total_gb": 31.5,
    "in_gb": 8.2,
    "out_gb": 23.3,
    "limit_gb": 4000,
    "days": [
      {
        "date": "2026-11-01",
        "total_gb": 6.4
      }
    ],
    "checked_at": "2026-11-05T09:00:00+02:00"
  },
  "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": {}
  }
}

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.
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 os sistemas para reinstalar

/v1/servers/{id}/operating-systems
GEThttps://api.mozout.com/v1/servers/{id}/operating-systems

Precisa de vps:read. Os sistemas que este servidor pode instalar. Use o id na operação de reinstalar.

Autenticação

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

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do servidor, o mesmo do seu 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/servers/00000000-0000-4000-8000-000000000000/operating-systems" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/operating-systems');
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/servers/00000000-0000-4000-8000-000000000000/operating-systems", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

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

Respostas

200

Listar os sistemas para reinstalar.

{
  "data": [
    {
      "id": "ubuntu-24.04",
      "name": "Ubuntu",
      "version": "24.04"
    }
  ],
  "meta": {
    "total": 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": {}
  }
}

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.
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 cópias

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

Precisa de vps:read. kind é automatic ou on_demand. Um servidor tem no máximo 4 cópias, contando as automáticas. O id muda quando a cópia muda. Vem de uma cópia com até 2 minutos.

Autenticação

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

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do servidor, o mesmo do seu 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/servers/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/servers/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/servers/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/servers/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 cópias.

{
  "data": [
    {
      "id": "3f9a1c7e5b2d4860",
      "title": "Daily automatic backup",
      "kind": "automatic",
      "created_at": "2026-11-05T02:10:00+02:00",
      "size_gb": 12.4
    }
  ],
  "meta": {
    "total": 1,
    "max": 4,
    "checked_at": "2026-11-05T09:00:00+02:00"
  }
}
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": {}
  }
}

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.
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

Fazer uma cópia

/v1/servers/{id}/backups
POSThttps://api.mozout.com/v1/servers/{id}/backups

Precisa de vps:write. Responde 202; a cópia pode demorar até 50 minutos a aparecer. Com 4 cópias responde 409 com backup_limit_reached.

Autenticação

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

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do servidor, o mesmo do seu serviço.
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, algarismos, ponto, hífen e sublinhado, até 30.

Exemplos

curl

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

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/backups');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"name": "before-update"}',
    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": "before-update"}
r = requests.post("https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/backups", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/backups", {
  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": "before-update"}),
});
console.log(response.status);
console.log(await response.text());

Respostas

202

Fazer uma cópia.

{
  "data": {
    "action_id": "6f1d2c3a-8b4e-4f7a-9c21-1d2e3f4a5b6c",
    "status": "running",
    "simulated": false,
    "server_id": 700,
    "server": "web1.example.co.mz",
    "name": "before-update"
  },
  "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.

400

O pedido não é válido, por exemplo o corpo não é JSON ou a ligação não é HTTPS.

{
  "error": {
    "code": "invalid_request",
    "message": "O pedido não é válido.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

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
400invalid_requestO pedido não é válido, por exemplo o corpo não é JSON ou a ligação não é HTTPS.
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

Ligar um servidor

/v1/servers/{id}/start
POSThttps://api.mozout.com/v1/servers/{id}/start

Precisa de vps:write. Responde 202. Demora cerca de 2 minutos. Se já estiver ligado, 409 com already_running.

Autenticação

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

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do servidor, o mesmo do seu serviço.
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/servers/00000000-0000-4000-8000-000000000000/start" \
  -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/servers/00000000-0000-4000-8000-000000000000/start');
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/servers/00000000-0000-4000-8000-000000000000/start", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/start", {
  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

Ligar um servidor.

{
  "data": {
    "action_id": "6f1d2c3a-8b4e-4f7a-9c21-1d2e3f4a5b6c",
    "status": "running",
    "simulated": false,
    "server_id": 700,
    "server": "web1.example.co.mz"
  },
  "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.

400

O pedido não é válido, por exemplo o corpo não é JSON ou a ligação não é HTTPS.

{
  "error": {
    "code": "invalid_request",
    "message": "O pedido não é válido.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

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
400invalid_requestO pedido não é válido, por exemplo o corpo não é JSON ou a ligação não é HTTPS.
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

Desligar um servidor

/v1/servers/{id}/stop
POSThttps://api.mozout.com/v1/servers/{id}/stop

Precisa de vps:write. Responde 202. Pode demorar cerca de 6 minutos. Se já estiver desligado, 409 com already_stopped.

Autenticação

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

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do servidor, o mesmo do seu serviço.
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/servers/00000000-0000-4000-8000-000000000000/stop" \
  -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/servers/00000000-0000-4000-8000-000000000000/stop');
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/servers/00000000-0000-4000-8000-000000000000/stop", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/stop", {
  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

Desligar um servidor.

{
  "data": {
    "action_id": "6f1d2c3a-8b4e-4f7a-9c21-1d2e3f4a5b6c",
    "status": "running",
    "simulated": false,
    "server_id": 700,
    "server": "web1.example.co.mz"
  },
  "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.

400

O pedido não é válido, por exemplo o corpo não é JSON ou a ligação não é HTTPS.

{
  "error": {
    "code": "invalid_request",
    "message": "O pedido não é válido.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

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
400invalid_requestO pedido não é válido, por exemplo o corpo não é JSON ou a ligação não é HTTPS.
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

Reiniciar um servidor

/v1/servers/{id}/restart
POSThttps://api.mozout.com/v1/servers/{id}/restart

Precisa de vps:write. Responde 202. Se estiver desligado, 409 com server_stopped.

Autenticação

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

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do servidor, o mesmo do seu serviço.
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/servers/00000000-0000-4000-8000-000000000000/restart" \
  -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/servers/00000000-0000-4000-8000-000000000000/restart');
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/servers/00000000-0000-4000-8000-000000000000/restart", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/restart", {
  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

Reiniciar um servidor.

{
  "data": {
    "action_id": "6f1d2c3a-8b4e-4f7a-9c21-1d2e3f4a5b6c",
    "status": "running",
    "simulated": false,
    "server_id": 700,
    "server": "web1.example.co.mz"
  },
  "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.

400

O pedido não é válido, por exemplo o corpo não é JSON ou a ligação não é HTTPS.

{
  "error": {
    "code": "invalid_request",
    "message": "O pedido não é válido.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

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
400invalid_requestO pedido não é válido, por exemplo o corpo não é JSON ou a ligação não é HTTPS.
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

Gerar uma nova senha de root

/v1/servers/{id}/password
POSThttps://api.mozout.com/v1/servers/{id}/password

Precisa de vps:password. Esta permissão é separada de vps:write e fica desligada por omissão, porque a resposta traz a senha de root. Precisa do nome do servidor em confirm. O servidor reinicia para a aplicar, e a nova senha funciona depois disso, em 1 a 2 minutos. Aparece só nesta resposta: não a guardamos nos registos da API. Repetir com a mesma Idempotency-Key não gera outra e devolve password a null. Em Sandbox a senha não é verdadeira.

Autenticação

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

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do servidor, o mesmo do seu serviço.
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
confirmstringsimO name do servidor, para confirmar.

Exemplos

curl

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

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/password');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"confirm": "web1.example.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 = {"confirm": "web1.example.co.mz"}
r = requests.post("https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/password", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

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

Respostas

202

Gerar uma nova senha de root.

{
  "data": {
    "action_id": "6f1d2c3a-8b4e-4f7a-9c21-1d2e3f4a5b6c",
    "status": "running",
    "simulated": false,
    "server_id": 700,
    "server": "web1.example.co.mz",
    "password": "pP7-kX2mQ9vL4tR8wZ3a"
  },
  "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.

400

O pedido não é válido, por exemplo o corpo não é JSON ou a ligação não é HTTPS.

{
  "error": {
    "code": "invalid_request",
    "message": "O pedido não é válido.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

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
400invalid_requestO pedido não é válido, por exemplo o corpo não é JSON ou a ligação não é HTTPS.
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 o DNS reverso

/v1/servers/{id}/reverse-dns
GEThttps://api.mozout.com/v1/servers/{id}/reverse-dns

Precisa de vps:read. O nome de cada IP do servidor. hostname é null enquanto for o de origem. Vem de uma cópia com até 5 minutos.

Autenticação

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

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do servidor, o mesmo do seu 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/servers/00000000-0000-4000-8000-000000000000/reverse-dns" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/reverse-dns');
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/servers/00000000-0000-4000-8000-000000000000/reverse-dns", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

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

Respostas

200

Ver o DNS reverso.

{
  "data": {
    "server_id": 700,
    "records": [
      {
        "ip": "203.0.113.10",
        "hostname": "mail.example.co.mz"
      }
    ],
    "checked_at": "2026-11-05T09:00:00+02:00"
  },
  "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": {}
  }
}

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.
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 o DNS reverso

/v1/servers/{id}/reverse-dns
PUThttps://api.mozout.com/v1/servers/{id}/reverse-dns

Precisa de vps:write. Se não for possível ler a lista de IP do servidor, responde 502 e nada muda. Só os IP deste servidor, até 64. Um hostname vazio limpa-o. changed diz quantos estavam diferentes.

Autenticação

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

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do servidor, o mesmo do seu 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.

Corpo do pedido

CampoTipoObrigatórioDescrição
recordsarray<object>sim

Exemplos

curl

curl -X PUT "https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/reverse-dns" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Content-Type: application/json" \
  -d '{"records": [{"ip": "203.0.113.10", "hostname": "mail.example.co.mz"}]}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/reverse-dns');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_POSTFIELDS => '{"records": [{"ip": "203.0.113.10", "hostname": "mail.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 = {"records": [{"ip": "203.0.113.10", "hostname": "mail.example.co.mz"}]}
r = requests.put("https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/reverse-dns", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/reverse-dns", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"records": [{"ip": "203.0.113.10", "hostname": "mail.example.co.mz"}]}),
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Mudar o DNS reverso.

{
  "data": {
    "server_id": 700,
    "server": "web1.example.co.mz",
    "changed": 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.

GET

Ver o fuso horário

/v1/servers/{id}/timezone
GEThttps://api.mozout.com/v1/servers/{id}/timezone

Precisa de vps:read. O último fuso gravado e os que pode escolher. timezone é null se ainda não foi escolhido.

Autenticação

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

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do servidor, o mesmo do seu 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/servers/00000000-0000-4000-8000-000000000000/timezone" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/timezone');
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/servers/00000000-0000-4000-8000-000000000000/timezone", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

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

Respostas

200

Ver o fuso horário.

{
  "data": {
    "server_id": 700,
    "timezone": "Africa/Maputo",
    "available": [
      "Africa/Maputo",
      "UTC"
    ]
  },
  "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": {}
  }
}

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.
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 o fuso horário

/v1/servers/{id}/timezone
PUThttps://api.mozout.com/v1/servers/{id}/timezone

Precisa de vps:write. Responde 202. A acção acaba passados cerca de 2 minutos, sem confirmação no servidor.

Autenticação

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

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do servidor, o mesmo do seu 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.

Corpo do pedido

CampoTipoObrigatórioDescrição
timezonestringsim

Exemplos

curl

curl -X PUT "https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/timezone" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Content-Type: application/json" \
  -d '{"timezone": "Africa/Maputo"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/timezone');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_POSTFIELDS => '{"timezone": "Africa/Maputo"}',
    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 = {"timezone": "Africa/Maputo"}
r = requests.put("https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/timezone", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

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

Respostas

202

Mudar o fuso horário.

{
  "data": {
    "action_id": "6f1d2c3a-8b4e-4f7a-9c21-1d2e3f4a5b6c",
    "status": "running",
    "simulated": false,
    "server_id": 700,
    "server": "web1.example.co.mz",
    "timezone": "Africa/Maputo"
  },
  "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.

POST

Reinstalar um servidor

/v1/servers/{id}/reinstall
POSThttps://api.mozout.com/v1/servers/{id}/reinstall

Precisa de vps:reinstall. Apaga tudo o que está no servidor. Precisa de Idempotency-Key, do nome do servidor em confirm e de backup_first. Com backup_first a true, primeiro faz uma cópia e reinstala sozinho quando a cópia aparecer, o que pode demorar até uma hora; com 4 cópias responde 409 com backup_limit_reached e não apaga nada. A nova senha de root aparece só nesta resposta e funciona quando a reinstalação acabar. Até 3 por hora, contando os restauros.

Autenticação

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

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do servidor, o mesmo do seu serviço.
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
confirmstringsimO name do servidor, para confirmar.
operating_systemstringsimO id do sistema, da lista.
backup_firstbooleansimFazer uma cópia antes de reinstalar.

Exemplos

curl

curl -X POST "https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/reinstall" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"confirm": "web1.example.co.mz", "operating_system": "ubuntu-24.04", "backup_first": true}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/reinstall');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"confirm": "web1.example.co.mz", "operating_system": "ubuntu-24.04", "backup_first": true}',
    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 = {"confirm": "web1.example.co.mz", "operating_system": "ubuntu-24.04", "backup_first": true}
r = requests.post("https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/reinstall", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

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

Respostas

202

Reinstalar um servidor.

{
  "data": {
    "action_id": "6f1d2c3a-8b4e-4f7a-9c21-1d2e3f4a5b6c",
    "status": "running",
    "simulated": false,
    "server_id": 700,
    "server": "web1.example.co.mz",
    "operating_system": "ubuntu-24.04",
    "backup_first": true,
    "password": "pP7-kX2mQ9vL4tR8wZ3a"
  },
  "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.

400

O pedido não é válido, por exemplo o corpo não é JSON ou a ligação não é HTTPS.

{
  "error": {
    "code": "invalid_request",
    "message": "O pedido não é válido.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

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
400invalid_requestO pedido não é válido, por exemplo o corpo não é JSON ou a ligação não é HTTPS.
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

Restaurar uma cópia

/v1/servers/{id}/restore
POSThttps://api.mozout.com/v1/servers/{id}/restore

Precisa de vps:restore. O servidor volta ao estado da cópia: tudo o que mudou depois dela perde-se. Precisa de Idempotency-Key e do nome do servidor em confirm. Até 3 por hora, contando as reinstalações.

Autenticação

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

Parâmetros

NomeOndeTipoObrigatórioDescrição
idcaminhostringsimO id do servidor, o mesmo do seu serviço.
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
confirmstringsimO name do servidor, para confirmar.
backupstringsimO id da cópia, da lista.

Exemplos

curl

curl -X POST "https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/restore" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"confirm": "web1.example.co.mz", "backup": "3f9a1c7e5b2d4860"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/restore');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"confirm": "web1.example.co.mz", "backup": "3f9a1c7e5b2d4860"}',
    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 = {"confirm": "web1.example.co.mz", "backup": "3f9a1c7e5b2d4860"}
r = requests.post("https://api.mozout.com/v1/servers/00000000-0000-4000-8000-000000000000/restore", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

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

Respostas

202

Restaurar uma cópia.

{
  "data": {
    "action_id": "6f1d2c3a-8b4e-4f7a-9c21-1d2e3f4a5b6c",
    "status": "running",
    "simulated": false,
    "server_id": 700,
    "server": "web1.example.co.mz",
    "backup": "3f9a1c7e5b2d4860"
  },
  "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.

400

O pedido não é válido, por exemplo o corpo não é JSON ou a ligação não é HTTPS.

{
  "error": {
    "code": "invalid_request",
    "message": "O pedido não é válido.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

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
400invalid_requestO pedido não é válido, por exemplo o corpo não é JSON ou a ligação não é HTTPS.
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.