---
title: "Get S3 configuration"
method: GET
path: "/v1/integrations/s3"
tags: ["Integrations"]
---

# Get S3 configuration

`GET /v1/integrations/s3`

Get current S3 storage configuration.

**Authentication:** API Key required (`x-api-key` header)

**Usage:** Retrieve your S3 integration settings. Secret access key is masked for security.

**Returns 404** if S3 is not configured.

**No credits consumed:** This is a read-only endpoint.

**Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.

## Response `200`

S3 configuration retrieved successfully

- S3ConfigResponse — Response for S3 configuration (with masked secret)
  - `configured` boolean, required — Whether S3 is configured
  - `endpoint_url` string, required — S3-compatible endpoint URL
  - `access_key_id` string, required — Access key ID
  - `secret_access_key_masked` string, required — Masked secret access key (shows first 4 and last 4 characters)
  - `bucket_name` string, required — S3 bucket name
  - `default_prefix` string, required — Default path prefix for uploads

## Other responses

- `404` — S3 is not configured
- `422` — Validation Error

---

[API](https://skmtc.net/pdftemplateapi/apis/templatefox-api.md) · [All operations](https://skmtc.net/pdftemplateapi/apis/templatefox-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pdftemplateapi/templatefox-api/revisions/5673fc0d5fad/schema)