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

# Listar regiões (IAM legado)

> Endpoint de compatibilidade legado. Novos clientes devem usar catalog.basaltic.sh/v1/regions. Esse endpoint mantém CRNs de região com namespaces do IAM e sua forma de resposta existente. Lista todas as regiões publicadas. Esse endpoint é público e não requer autenticação. Retorna todas as regiões com seu status de disponibilidade.

Como não requer credenciais, as solicitações são limitadas por taxa por IP do cliente.


<Info>
  Requer **nenhuma ação do IAM**. O acesso é decidido pelas próprias regras do endpoint, e não por uma política — consulte a descrição acima.
</Info>


## OpenAPI

````yaml /pt/api-reference/specs/iam.yaml get /v1/regions
openapi: 3.0.3
info:
  title: API do Basaltic IAM
  version: 1.0.0
  description: >
    Gerenciamento de identidade e acesso de conta: contas de serviço, funções,
    políticas de conta e sessões temporárias com escopo de conta. A autenticação
    e o login pessoal permanecem no IAM. Organizações, contas, usuários, grupos
    e políticas da organização são gerenciados pela API do Workspace.


    As funções e políticas personalizadas pertencem à conta selecionada.Seus
    CRNs globais usam uma região vazia e o identificador da conta proprietária.
    Políticas de sistema compartilhadas usam crn:iam:::policy/<name>As entradas
    de relacionamento são classificadas uma vez como CRN, UUID ou nome, sem
    fallback de sintaxe.


    AssumeRole resolve a conta de propriedade da função de destino. O chamador
    precisa de permissão de origem e a função de destino deve confiar no
    chamador; a sessão resultante usa somente as permissões da função de
    destino, sujeita a limites e restrições de sessão.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://iam.basaltic.sh
    description: Endpoint global da API
security:
  - BearerAuth: []
paths:
  /v1/regions:
    get:
      tags:
        - Regions
      summary: Listar regiões (IAM legado)
      description: >
        Endpoint de compatibilidade legado. Novos clientes devem usar
        catalog.basaltic.sh/v1/regions. Esse endpoint mantém CRNs de região com
        namespaces do IAM e sua forma de resposta existente. Lista todas as
        regiões publicadas. Esse endpoint é público e não requer autenticação.
        Retorna todas as regiões com seu status de disponibilidade.


        Como não requer credenciais, as solicitações são limitadas por taxa por
        IP do cliente.
      operationId: listRegions
      parameters:
        - $ref: '#/components/parameters/IAMNameFilter'
        - $ref: '#/components/parameters/IAMCRNFilter'
      responses:
        '200':
          description: Lista de regiões
          content:
            application/json:
              schema:
                type: object
                required:
                  - regions
                  - default
                properties:
                  regions:
                    type: array
                    description: Lista de regiões disponíveis
                    items:
                      $ref: '#/components/schemas/Region'
                  default:
                    type: string
                    description: The default region code
                    example: sa-saopaulo-1
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      deprecated: true
      security: []
components:
  parameters:
    IAMNameFilter:
      name: name
      in: query
      allowEmptyValue: true
      description: >-
        Nome exato do recurso, combinado com crn usando AND antes da paginação.
        Valores vazios são filtros. Recursos sem um nome nunca correspondem.
      schema:
        type: string
    IAMCRNFilter:
      name: crn
      in: query
      allowEmptyValue: true
      description: >-
        Exato CRN retornado, combinado com o nome usando AND antes da paginação.
        CRNs mal formados ou vazios retornam 400; CRNs válidos incompatíveis ou
        estrangeiros retornam uma página vazia. Recursos sem um CRN nunca
        correspondem. CRNs com escopo de organização usam a organização
        autenticada.
      schema:
        type: string
  schemas:
    Region:
      type: object
      required:
        - crn
        - code
        - name
        - location
        - country_code
        - available
        - coming_soon
      properties:
        crn:
          type: string
          description: >-
            Identidade de região global de propriedade da plataforma, usando o
            código de região imutável.
          example: crn:iam::platform:region/sa-saopaulo-1
        code:
          type: string
          description: Código de região exclusivo usado em chamadas de API e CRNs
          example: sa-saopaulo-1
        name:
          type: string
          description: Nome de região legível por humanos
          example: São Paulo 1
        location:
          type: string
          description: Localização geográfica da região
          example: São Paulo, Brazil
        country_code:
          type: string
          description: >-
            Código de país ISO 3166-1 alfa-2 (usado para exibir a bandeira na
            interface do usuário)
          example: BR
          minLength: 2
          maxLength: 2
        available:
          type: boolean
          description: Se a região está disponível para uso no momento
          example: true
        coming_soon:
          type: boolean
          description: Se a região é anunciada, mas ainda não está disponível
          example: false
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Código de erro identificando o tipo de erro
              example: INVALID_INPUT
            message:
              type: string
              description: Mensagem de erro legível pelo ser humano
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Valores não sensíveis opcionais para interpolação de erros
                localizados, codificados por código de erro. Nunca presente para
                erros de servidor.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Solicitar ID para depuração
              example: 550e8400-e29b-41d4-a716-446655440000
  responses:
    TooManyRequests:
      description: >
        Limite de taxa excedido. O orçamento é uma janela fixa contada por
        endpoint e por chamador — o principal autenticado quando a solicitação
        carrega credenciais, o IP do cliente caso contrário — para que um
        endpoint limitado nunca gaste o orçamento de outro e um locatário nunca
        gaste o de outro.


        Aguarde `Retry-After` segundos, em seguida, tente novamente. Os
        cabeçalhos `X-RateLimit-*` também são baseados nas respostas
        bem-sucedidas de um endpoint com taxa limitada, para que um cliente
        possa se adaptar ao invés de descobrir o limite ao atingi-lo.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: RATE_LIMITED
              message: Too many requests, please try again later
              request_id: 550e8400-e29b-41d4-a716-446655440000
      headers:
        Retry-After:
          description: Segundos para aguardar antes de tentar novamente. Nunca zero.
          required: true
          schema:
            type: integer
            minimum: 1
          example: 42
        X-RateLimit-Limit:
          description: Solicitações permitidas por janela neste endpoint.
          required: true
          schema:
            type: integer
            minimum: 1
          example: 5
        X-RateLimit-Remaining:
          description: Solicitações deixadas na janela atual. Sempre 0 em um 429.
          required: true
          schema:
            type: integer
            minimum: 0
          example: 0
        X-RateLimit-Reset:
          description: >-
            Segundos até que a janela seja redefinida — uma duração, não um
            carimbo de data/hora, portanto, não precisa de acordo de clock entre
            cliente e servidor.
          required: true
          schema:
            type: integer
            minimum: 1
          example: 42
    InternalServerError:
      description: Erro interno do servidor
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INTERNAL_ERROR
              message: An internal error occurred
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >+
        Um token bearer OAuth 2.0, enviado como `Authorization: Bearer <token>`.
        Esta é a forma recomendada de autenticação.


        Obtenha o token trocando o par de chaves de acesso de uma conta de
        serviço em `POST /v1/oauth/token` com `grant_type=client_credentials`.
        Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis
        com OAuth podem obter e renovar o token para você.


        ```

        curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
          https://iam.basaltic.sh/v1/oauth/token
        ```


        Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso
        também serve como credencial AWS SigV4 para o endpoint de objetos
        compatível com S3, que aceita somente esse método de autenticação.


````

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