---
title: "Consultar endpoint de recuperação"
method: GET
path: "/v1/recovery/endpoint"
tags: ["Recuperação"]
---

# Consultar endpoint de recuperação

`GET /v1/recovery/endpoint`

## Request

- Base URL: `https://api.ararahq.com`
- URL: `https://api.ararahq.com/v1/recovery/endpoint`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/ararahq/apis/ararahq-api/docs/v1/recovery/endpoint/get.ts> (a function with typed inputs; its response is checked against the schema)

Devolve o `hmacSecret`: trate como segredo. Permissão: `ADMIN`.

## Response `200`

Endpoint

- RecoveryEndpointResponse
  - `code` string, required
  - `hmacSecret` string, required: Segredo HMAC da ingestão. Trate como senha.
  - `active` boolean, required
  - `url` string, required: URL pública de ingestão (`.../l/{code}`).

## Other responses

- `401`: Chave inexistente, revogada, expirada, com prefixo errado (`ara_` sem `ara_live_`) ou vinda de IP fora da allowlist. O corpo é o JSON padrão do Spring, sem `error.code`.
- `403`: Dois casos, com corpos diferentes: - Autenticação: header `Authorization` ausente, Bearer que não começa com `ara_`, chave sem a permissão da rota ou rota que não aceita chave de API. Corpo no formato padrão do Spring, sem `error.code`. - Regra de negócio, no formato `{ "error": { ... } }`: `PLAN_FEATURE_LOCKED`, `PLAN_LIMIT_REACHED`, `ACCOUNT_NOT_ACTIVATED`, `NO_DEDICATED_NUMBER`, `ORGANIZATION_SUSPENDED`, `NUMBER_BLOCKED`, `FRAUD_SUSPECTED`, `RESOURCE_FORBIDDEN`, `VIEWER_READ_ONLY`.
- `429`: `RATE_LIMIT_EXCEEDED`: limite geral da API (1.200 leituras ou 3.000 escritas por minuto, por usuário da chave).

## Changes

- **2026-10-12** `d576cd28afc0`: 3 info
  - api tag `Recuperação` added
  - api tag `recovery` removed
  - added the non-success response with the status `429`
- **2026-09-15** `372d8c2e735d`: 4 breaking, 1 warning, 4 info
  - the response property `error` became optional for the status `401`
  - the `error` response's property type changed from `object` to `string` for status `401`
  - removed the required property `error/code` from the response with the `401` status
  - removed the required property `error/message` from the response with the `401` status
  - …5 more
- **2026-05-25** `4e426b85f784`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/ararahq/apis/ararahq-api/changes/v1/recovery/endpoint/get.md)

---

[API](https://skmtc.dev/ararahq/apis/ararahq-api.md) - [All operations](https://skmtc.dev/ararahq/apis/ararahq-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ararahq/apis/ararahq-api/revisions/d576cd28afc0?raw)