> ## 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 > Lista de regiões publicadas, incluindo locais planeados e em retirada. Nenhuma autenticação é necessária. As solicitações são limitadas por taxa por IP do cliente. Os filtros nome exato e CRN combinam com AND; um nome vazio não corresponde a nada e um CRN vazio ou mal formado retorna 400. O padrão é a região de aceitação configurada se estiver no resultado, caso contrário, a primeira região de aceitação por código, ou uma string vazia quando nenhuma aceitar novos recursos. Respostas bem-sucedidas podem ser armazenadas em cache de forma privada por 60 segundos. A descoberta não concede permissões de provisionamento nem garante capacidade ou integridade. Uma interrupção ou desativação de catálogo não exclui recursos nem altera seu posicionamento existente. 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. ## OpenAPI ````yaml /pt/api-reference/specs/catalog.yaml get /v1/regions openapi: 3.0.3 info: title: API do Basaltic Catalog version: 1.0.0 description: >- Descoberta de plataforma global pública. O ciclo de vida é independente da integridade ao vivo, capacidade, autorização do locatário e colocação de produto. contact: name: Basaltic Support email: ping@basaltic.sh license: name: Proprietary url: https://basaltic.sh/terms servers: - url: https://catalog.basaltic.sh description: Endpoint de catálogo global security: [] paths: /v1/regions: get: tags: - Regions summary: Listar regiões description: > Lista de regiões publicadas, incluindo locais planeados e em retirada. Nenhuma autenticação é necessária. As solicitações são limitadas por taxa por IP do cliente. Os filtros nome exato e CRN combinam com AND; um nome vazio não corresponde a nada e um CRN vazio ou mal formado retorna 400. O padrão é a região de aceitação configurada se estiver no resultado, caso contrário, a primeira região de aceitação por código, ou uma string vazia quando nenhuma aceitar novos recursos. Respostas bem-sucedidas podem ser armazenadas em cache de forma privada por 60 segundos. A descoberta não concede permissões de provisionamento nem garante capacidade ou integridade. Uma interrupção ou desativação de catálogo não exclui recursos nem altera seu posicionamento existente. operationId: listRegions parameters: - $ref: '#/components/parameters/IAMNameFilter' - $ref: '#/components/parameters/IAMCRNFilter' responses: '200': description: Regiões publicadas content: application/json: schema: type: object required: - regions - default properties: regions: type: array items: $ref: '#/components/schemas/Region' default: type: string description: Default accepting region code, or an empty string. example: sa-saopaulo-1 '400': $ref: '#/components/responses/BadRequest' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' 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 - state - accepting_new_resources - available - coming_soon properties: state: type: string enum: - planned - active - restricted - retiring - retired description: >- Ciclo de vida do catálogo, independente da integridade e da capacidade. Os códigos desativados nunca são reutilizados. example: active accepting_new_resources: type: boolean description: >- Verdadeiro apenas para regiões ativas. Os serviços de produto ainda aplicam elegibilidade, cotas, posicionamento e capacidade. example: true crn: type: string description: >- Identidade de região global de propriedade da plataforma, usando o código de região imutável. example: crn:catalog::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: >- Alias de compatibilidade para accepting_new_resources; não um sinal de saúde ao vivo example: true coming_soon: type: boolean description: >- Sinal de compatibilidade que é verdadeiro somente quando o estado é planejado 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: BadRequest: description: Parâmetros de solicitação inválidos content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: INVALID_INPUT message: Invalid request parameters request_id: 550e8400-e29b-41d4-a716-446655440000 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 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.