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

# Referência da API

> APIs de serviço, escopo de recursos e autenticação de portador.

Cada parte do Basaltic é uma API HTTP. O console e a CLI são clientes desses mesmos endpoints — não há nada no produto que eles possam alcançar que você não possa.

<a id="how-this-reference-is-generated" />

## Como esta referência é gerada

Essas páginas são geradas a partir das especificações OpenAPI que os serviços são construídos e verificados, não escritos à mão ao lado deles. Uma operação aparece aqui porque ela existe, com as formas de solicitação e resposta que o serviço realmente implementa, incluindo as respostas de erro, que são documentadas em vez de serem deixadas para serem descobertas.

<a id="conventions" />

## Convenções

**Versioning.** Cada caminho é prefixado com `/v1`.

**Identificadores.** As respostas de recursos expõem identidades canônicas. Os caminhos de recursos UUID usam o `id` retornado; campos de referência de solicitação aceitam apenas os tipos declarados por sua operação. Consulte [References](/pt/reference-resolution) para nomes com escopo, CRNs aninhados, versões de imagem, filtros de lista exata e busca de um recurso por qualquer referência. CRNs com escopo organizacional exigem o contexto organizacional autenticado.

**Errors.** As falhas retornam um corpo JSON com um código estável e legível por máquina. Combine o código, não a mensagem legível por humanos, que pode mudar.

**Falhas.** Recursos que executam trabalho em segundo plano sempre incluem `faults`: um array de observações ativas, ou `[]` quando nenhuma permanece. Veja [Resource faults](/pt/resource-faults) para o array, a ordem, a recuperação e como a gravidade mapeia para o status.

**Idempotência e trabalho assíncrono.** Operações que entregam a um fluxo de trabalho em segundo plano respondem `202 Accepted` em vez de fingir que o trabalho foi feito. Sonda o recurso até que ele atinja um estado terminal; um `202` seguido de uma leitura que ainda mostra o estado antigo é o contrato funcionando, não um bug.

**Paginação.** Lista de operações da página. Siga os campos de paginação na resposta em vez de assumir que você tem tudo.

<a id="getting-started" />

## Começando a usar

<CardGroup cols={2}>
  <Card title="Autenticação" icon="key" href="/pt/authentication">
    Tokens de portador, sessões de função de conta e origem das credenciais.
  </Card>

  <Card title="Regiões e endpoints" icon="globe" href="/pt/regions">
    Em qual host cada serviço responde e quais são globais.
  </Card>

  <Card title="Início rápido" icon="rocket" href="/pt/quickstart">
    Uma solicitação autenticada em funcionamento, de ponta a ponta.
  </Card>

  <Card title="CLI" icon="terminal" href="/pt/cli">
    Use as APIs a partir do seu terminal.
  </Card>
</CardGroup>

<a id="the-apis" />

## As APIs da Web

**Workspace** — Organizações, contas, usuários, grupos, convites e políticas da organização. Global, com autorização de escopo organizacional.

**Identidade e conta** — O IAM gerencia funções de conta, contas de serviço, políticas de conta e sessões. Cota, Auditoria e Faturamento exigem subsídios da organização. Esses serviços usam endpoints globais; o IAM de conta ainda requer escopo de conta.

**Compute** — Compute (instâncias, imagens, variantes, pools de instâncias) e Database (cluster gerenciado).

**Networking** — Rede (VPCs, sub-redes, gateways, IPs flutuantes), balanceador de carga, DNS, certificado.

**Armazenamento** — Armazenamento (volumes de bloco, snapshots, buckets). O protocolo de fio S3 é servido separadamente; consulte [object storage](/pt/regions#object-storage).

**Segurança** — KMS (chaves de criptografia), segredos.

**Observabilidade** — Telemetria (logs, métricas, rastros).


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