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

# List regions

> List all available regions. This endpoint is public and does not require authentication.
Returns all regions with their availability status.

Because it takes no credentials, requests are rate-limited per client IP.




## OpenAPI

````yaml /api-reference/specs/iam.yaml get /v1/regions
openapi: 3.0.3
info:
  title: Basaltic IAM API
  version: 1.0.0
  description: |
    Identity for the platform: organizations, accounts, users, groups,
    service accounts, roles and policies, together with the sign-in flows and
    the temporary STS credentials every other Basaltic API authenticates
    against.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://iam.basaltic.sh
    description: Global API endpoint
security:
  - SignatureAuth: []
paths:
  /v1/regions:
    get:
      tags:
        - Regions
      summary: List regions
      description: >
        List all available regions. This endpoint is public and does not require
        authentication.

        Returns all regions with their availability status.


        Because it takes no credentials, requests are rate-limited per client
        IP.
      operationId: listRegions
      responses:
        '200':
          description: List of regions
          content:
            application/json:
              schema:
                type: object
                required:
                  - regions
                  - default
                properties:
                  regions:
                    type: array
                    description: List of available regions
                    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'
      security: []
components:
  schemas:
    Region:
      type: object
      required:
        - code
        - name
        - location
        - country_code
        - available
        - coming_soon
      properties:
        code:
          type: string
          description: Unique region code used in API calls and CRNs
          example: sa-saopaulo-1
        name:
          type: string
          description: Human-readable region name
          example: São Paulo 1
        location:
          type: string
          description: Geographic location of the region
          example: São Paulo, Brazil
        country_code:
          type: string
          description: ISO 3166-1 alpha-2 country code (used to display flag in UI)
          example: BR
          minLength: 2
          maxLength: 2
        available:
          type: boolean
          description: Whether the region is currently available for use
          example: true
        coming_soon:
          type: boolean
          description: Whether the region is announced but not yet available
          example: false
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Error code identifying the type of error
              example: INVALID_INPUT
            message:
              type: string
              description: Human-readable error message
              example: Invalid request parameters
            request_id:
              type: string
              format: uuid
              description: Request ID for debugging
              example: 550e8400-e29b-41d4-a716-446655440000
  responses:
    TooManyRequests:
      description: >
        Rate limit exceeded. The budget is a fixed window counted per endpoint
        and

        per caller — the authenticated principal when the request carries

        credentials, the client IP otherwise — so one throttled endpoint never

        spends another's budget, and one tenant never spends another's.


        Wait `Retry-After` seconds, then retry. The `X-RateLimit-*` headers ride
        on

        the successful responses of a rate-limited endpoint too, so a client can

        pace itself instead of discovering the ceiling by hitting it.
      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: Seconds to wait before retrying. Never zero.
          required: true
          schema:
            type: integer
            minimum: 1
          example: 42
        X-RateLimit-Limit:
          description: Requests allowed per window on this endpoint.
          required: true
          schema:
            type: integer
            minimum: 1
          example: 5
        X-RateLimit-Remaining:
          description: Requests left in the current window. Always 0 on a 429.
          required: true
          schema:
            type: integer
            minimum: 0
          example: 0
        X-RateLimit-Reset:
          description: >-
            Seconds until the window resets — a duration, not a timestamp, so it
            needs no clock agreement between client and server.
          required: true
          schema:
            type: integer
            minimum: 1
          example: 42
    InternalServerError:
      description: Internal server error
      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:
    SignatureAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >
        Request signing with an access key issued to a service account. An

        HMAC-SHA256 over a canonical form of the request, close to AWS SigV4.

        The `basaltic` CLI signs for you.


        Send `Authorization`, `X-Date` (UTC, `YYYYMMDDTHHMMSSZ`) and `X-Nonce`

        (random per request); add `X-Content-Sha256` to bind a body, and

        `X-Amz-Security-Token` when using temporary credentials.


        ```

        Authorization: BASALTIC-HMAC-SHA256
        Credential=<access_key_id>/<date>/<region>/basaltic/basaltic_request,
        SignedHeaders=host;x-date;x-nonce, Signature=<hex>

        ```


        `<region>` is the region code you are calling, or `global` for the
        global

        services. A signature is valid for 5 minutes from `X-Date`, and mutating

        requests are replay-guarded on the nonce.


        **Full signing procedure, including a working implementation:**

        https://docs.basaltic.sh/authentication


        ## Rate limits

        There is no global request budget. A limit applies only where an

        operation documents a `429`, and that operation says what it counts.

        Those responses carry `X-RateLimit-Limit`, `X-RateLimit-Remaining`,

        `X-RateLimit-Reset` and, on a `429`, `Retry-After` — read them rather

        than hard-coding a number. Retrying before `Retry-After` is refused and

        extends the window. Everything else is bounded by quota, not by request

        rate.

````