> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tronrental.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar escopos de chaves de API

> Os escopos que uma chave de API pode ter, agrupados por tipo

## Listar escopos de chaves de API

Retorna o catálogo de escopos de chaves de API, agrupados do jeito que o painel os mostra. Use-o para
descobrir os nomes de escopo válidos.

As chaves do Node API são um tipo separado de chave: elas têm apenas o escopo `node_api`, nunca junto
com os outros escopos, e funcionam apenas em `node.tronrental.com`. Você as cria como endpoints em
[Painel → Node API](https://tronrental.com/dashboard/node-api); quantas você pode ter depende do seu
plano do Node API. Uma chave do Node API não pode chamar este endpoint — a API REST responde com
`403 NODE_API_KEY_ONLY`. Veja [Node API → Endpoints e chaves](/pt/node-api/authentication).

### Resposta

**read** `string[]`

Escopos de leitura: `view`, `deposit_view`

**node** `string[]`

O escopo do Node API: `node_api`. Uma chave com ele não tem nenhum outro escopo

**write** `string[]`

Escopos que gastam o saldo ou alteram serviços: `buy_energy`, `buy_bandwidth`, `smart_mode`,
`transfer_packages`, `energy_resale`

**danger** `string[]`

`withdraw`. Ativá-lo em uma chave exige 2FA e uma lista de IPs permitidos não vazia

**default** `string[]`

Escopos que uma nova chave da API REST recebe quando nenhum é escolhido: todos os escopos de leitura e
de escrita, sem `withdraw`

**locked** `string[]`

Escopos que toda chave da API REST sempre tem: `view`

### Exemplo

```bash theme={null}
curl https://api.tronrental.com/v1/auth/api-keys/scopes \
  -H "X-API-Key: your_api_key"
```

```json Response theme={null}
{
  "read": ["view", "deposit_view"],
  "node": ["node_api"],
  "write": ["buy_energy", "buy_bandwidth", "smart_mode", "transfer_packages", "energy_resale"],
  "danger": ["withdraw"],
  "default": ["view", "deposit_view", "buy_energy", "buy_bandwidth", "smart_mode", "transfer_packages", "energy_resale"],
  "locked": ["view"]
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.