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

# Get S3 Gateway Config

> Return the externally-reachable endpoint URL, the SigV4 signing
region, and the availability of the S3 protocol gateway. The endpoint
is assembled from the server's `VITE_API_BASE_URL` env var plus
`/storage/v1/s3`; the region is `S3_REGION` (fallback `AWS_REGION`,
default `us-east-2`); `available` reflects whether an S3-backed
storage provider is configured (`false` on local-filesystem storage).

Intended for Dashboard display so the UI doesn't make any
backend-topology assumptions client-side.




## OpenAPI

````yaml https://raw.githubusercontent.com/InsForge/InsForge/main/openapi/storage.yaml get /api/storage/s3/config
openapi: 3.0.3
info:
  title: Insforge Storage API
  version: 2.0.0
  description: Bucket-based storage system similar to S3
servers: []
security: []
paths:
  /api/storage/s3/config:
    get:
      tags:
        - S3 Access Keys
      summary: Get S3 Gateway Config
      description: |
        Return the externally-reachable endpoint URL, the SigV4 signing
        region, and the availability of the S3 protocol gateway. The endpoint
        is assembled from the server's `VITE_API_BASE_URL` env var plus
        `/storage/v1/s3`; the region is `S3_REGION` (fallback `AWS_REGION`,
        default `us-east-2`); `available` reflects whether an S3-backed
        storage provider is configured (`false` on local-filesystem storage).

        Intended for Dashboard display so the UI doesn't make any
        backend-topology assumptions client-side.
      responses:
        '200':
          description: Gateway config
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/S3GatewayConfig'
              example:
                data:
                  endpoint: https://proj.insforge.app/storage/v1/s3
                  region: us-east-2
                  available: true
        '401':
          description: Missing or invalid API key / admin token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - apiKey: []
components:
  schemas:
    S3GatewayConfig:
      type: object
      description: Read-only config of the S3 protocol gateway.
      required:
        - endpoint
        - region
        - available
      properties:
        endpoint:
          type: string
          description: Full URL clients should configure as their S3 endpoint.
          example: https://proj.insforge.app/storage/v1/s3
        region:
          type: string
          description: >-
            SigV4 signing region the gateway validates incoming requests
            against.
          example: us-east-2
        available:
          type: boolean
          description: |
            Whether the gateway is usable on this deployment. `true` when an
            S3-backed storage provider is configured; `false` on
            local-filesystem storage, where all gateway requests return
            `NotImplemented`.
          example: true
    ErrorResponse:
      type: object
      required:
        - error
        - message
        - statusCode
      properties:
        error:
          type: string
          description: Error code for programmatic handling
          example: VALIDATION_ERROR
        message:
          type: string
          description: Human-readable error message
          example: Invalid request
        statusCode:
          type: integer
          description: HTTP status code
          example: 400
        nextActions:
          type: string
          description: Suggested action to resolve the error
          example: Check your request parameters
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key

````