Snapshots
Obter job de snapshot
Lê um job de snapshot ou de restauração de uma aplicação ou banco de dados. Consulte-o até terminar. Exige o escopo snapshots:read.
GET
Obter job de snapshot
Use esta rota para acompanhar uma restauração (
Esta rota permite 120 requisições por minuto.
response.job_id) ou um snapshot manual
que respondeu 202 (response.job_id). Consulte-a a cada poucos segundos até o status ser ready, skipped ou failed.
O formato do job é o descrito em Listar jobs de snapshot.
O ID da aplicação ou do banco de dados a que o job pertence. Em uma restauração, é o recurso que está sendo restaurado.
Resposta
O job:
id, kind, resource_id, origin (só nos jobs de snapshot), status, reason (quando failed ou skipped), details (os detalhes desse erro, quando houver), snapshot_id (o snapshot que um job snapshot produziu, sempre presente quando está ready; em um job restore, o snapshot que está sendo restaurado), created_at, started_at, finished_at e, enquanto está running, progress.Só enquanto o job está
running, e pode faltar (por exemplo logo depois de começar, ou quando o progresso não é conhecido). Não vem em nenhum outro status.Respostas de erro
O código de erro que indica o motivo da falha. Valores possíveis:
AUTH_TOKEN_MISSING,API_KEY_INVALID,SESSION_REVOKED: o headerAuthorizationestá ausente, a chave de API é inválida ou a sessão do painel foi revogada (401).API_KEY_IP_DENIED,API_KEY_SCOPE_DENIED: a chave de API é usada a partir de um IP fora da sua allowlist, ou não tem o escoposnapshots:read(403).ACCESS_DENIED: você é membro de um workspace sem a permissão para esta ação, ou não enviou oworkspace_id(403).SNAPSHOT_NOT_FOUND: o job não foi encontrado (404).INTERNAL_SERVER_ERROR: ocorreu um erro inesperado no servidor.
Última modificação em 20 de novembro de 2026