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

> Lista de regiones publicadas, incluyendo ubicaciones planificadas y en retiro. No se requiere autenticación. Las solicitudes están limitadas por la velocidad por IP del cliente. Los filtros de nombre exacto y CRN se combinan con AND; un nombre vacío no coincide con nada y un CRN vacío o mal formado devuelve 400. El valor predeterminado es la región de aceptación configurada si está en el resultado, de lo contrario la primera región de aceptación por código, o una cadena vacía cuando ninguno acepta nuevos recursos.

Las respuestas correctas pueden almacenarse en caché de forma privada durante 60 segundos. El descubrimiento no concede permisos de aprovisionamiento ni garantiza la capacidad o el estado. Una interrupción o retirada del catálogo no elimina recursos ni cambia su ubicación existente.


<Info>
  Requiere **sin acción de IAM**. El acceso se decide por las propias reglas del punto final en lugar de por una política. Consulte la descripción anterior.
</Info>


## OpenAPI

````yaml /es/api-reference/specs/catalog.yaml get /v1/regions
openapi: 3.0.3
info:
  title: API de catálogo de Basaltic
  version: 1.0.0
  description: >-
    Descubrimiento de plataforma global pública. El ciclo de vida es
    independiente del estado de funcionamiento, la capacidad, la autorización
    del inquilino y la ubicación del producto.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://catalog.basaltic.sh
    description: Punto final del catálogo global
security: []
paths:
  /v1/regions:
    get:
      tags:
        - Regions
      summary: Listar regiones
      description: >
        Lista de regiones publicadas, incluyendo ubicaciones planificadas y en
        retiro. No se requiere autenticación. Las solicitudes están limitadas
        por la velocidad por IP del cliente. Los filtros de nombre exacto y CRN
        se combinan con AND; un nombre vacío no coincide con nada y un CRN vacío
        o mal formado devuelve 400. El valor predeterminado es la región de
        aceptación configurada si está en el resultado, de lo contrario la
        primera región de aceptación por código, o una cadena vacía cuando
        ninguno acepta nuevos recursos.


        Las respuestas correctas pueden almacenarse en caché de forma privada
        durante 60 segundos. El descubrimiento no concede permisos de
        aprovisionamiento ni garantiza la capacidad o el estado. Una
        interrupción o retirada del catálogo no elimina recursos ni cambia su
        ubicación existente.
      operationId: listRegions
      parameters:
        - $ref: '#/components/parameters/IAMNameFilter'
        - $ref: '#/components/parameters/IAMCRNFilter'
      responses:
        '200':
          description: Regiones 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: >-
        Nombre exacto del recurso, combinado con crn usando AND antes de la
        paginación. Los valores vacíos son filtros. Los recursos sin nombre
        nunca coinciden.
      schema:
        type: string
    IAMCRNFilter:
      name: crn
      in: query
      allowEmptyValue: true
      description: >-
        CRN exacto devuelto, combinado con el nombre usando AND antes de la
        paginación. Los CRN mal formados o vacíos devuelven 400; los CRN válidos
        no coincidentes o extranjeros devuelven una página vacía. Los recursos
        sin un CRN nunca coinciden. Los CRN de ámbito de organización usan la
        organización 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 del catálogo, independiente de la salud y la
            capacidad. Los códigos retirados nunca se reutilizan.
          example: active
        accepting_new_resources:
          type: boolean
          description: >-
            Es válido solo para regiones activas. Los servicios de producto
            siguen aplicando la elegibilidad, las cuotas, la colocación y la
            capacidad.
          example: true
        crn:
          type: string
          description: >-
            Identidad de región global de propiedad de la plataforma, utilizando
            el código de región inmutable.
          example: crn:catalog::platform:region/sa-saopaulo-1
        code:
          type: string
          description: Código de región único utilizado en llamadas a API y CRN
          example: sa-saopaulo-1
        name:
          type: string
          description: Nombre de región legible por humanos
          example: São Paulo 1
        location:
          type: string
          description: Ubicación geográfica de la región
          example: São Paulo, Brazil
        country_code:
          type: string
          description: >-
            Código de país ISO 3166-1 alfa-2 (utilizado para mostrar la bandera
            en la interfaz de usuario)
          example: BR
          minLength: 2
          maxLength: 2
        available:
          type: boolean
          description: >-
            Alias de compatibilidad para accepting_new_resources; no es una
            señal de estado en vivo
          example: true
        coming_soon:
          type: boolean
          description: >-
            Indicador de compatibilidad que es verdadero solo cuando se
            planifica el estado
          example: false
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Código de error que identifica el tipo de error
              example: INVALID_INPUT
            message:
              type: string
              description: Mensaje de error legible por el ser humano
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Valores no sensibles opcionales para la interpolación de errores
                localizados, codificados por código de error. Nunca presente por
                errores del servidor.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Solicitar ID para depuración
              example: 550e8400-e29b-41d4-a716-446655440000
  responses:
    BadRequest:
      description: Parámetros de solicitud no vá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: >
        Límite de velocidad excedido. El presupuesto es una ventana fija contada
        por punto final y por llamador (el principal autenticado cuando la
        solicitud lleva credenciales, la IP del cliente de lo contrario), de
        modo que un punto final con restricción nunca gasta el presupuesto de
        otro, y un inquilino nunca gasta el de otro.


        Espere `Retry-After` segundos, luego vuelva a intentarlo. Los
        encabezados `X-RateLimit-*` también se basan en las respuestas exitosas
        de un punto final con límite de velocidad, por lo que un cliente puede
        acelerarse en lugar de descubrir el límite al alcanzarlo.
      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 esperar antes de volver a intentarlo. Nunca a cero.
          required: true
          schema:
            type: integer
            minimum: 1
          example: 42
        X-RateLimit-Limit:
          description: Solicitudes permitidas por ventana en este punto final.
          required: true
          schema:
            type: integer
            minimum: 1
          example: 5
        X-RateLimit-Remaining:
          description: Solicitudes que quedan en la ventana actual. Siempre 0 en un 429.
          required: true
          schema:
            type: integer
            minimum: 0
          example: 0
        X-RateLimit-Reset:
          description: >-
            Segundos hasta que la ventana se reinicia: una duración, no una
            marca de tiempo, por lo que no necesita ningún acuerdo de reloj
            entre el cliente y el servidor.
          required: true
          schema:
            type: integer
            minimum: 1
          example: 42
    InternalServerError:
      description: Error interno del 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.