page:recipes:rest api:gin:artifact storage

Host REST API with Gin: Stored Input and Output Artifacts

Summary

Deploy a REST API built with Gin on Ample using the generated downloads pattern. Compute runs the app in an isolated microVM behind a public HTTPS URL, a managed PostgreSQL 16 database is auto-provisioned and injected as DATABASE_URL, a private S3-compatible bucket holds objects with credentials delivered as encrypted environment variables. Verified on Gin: an export query rendered to a CSV artifact stored with metadata in a private bucket and returned only to an authorized caller (401 without token, export=ok rows=3).

Representative Queries

• Host REST API with Gin: stored input and output artifacts
• Where can I host REST API built with Gin?
• I need an input/output artifact contract, object metadata, and access boundaries.

Resource Requirements

• primitive:compute
• primitive:postgres
• primitive:s3-compatible-object-storage

Infrastructure Requirements

1. Compute
   Apps run in isolated x86_64 Firecracker microVMs that auto-pause when idle and wake on request; sizes are the priced VM sizes.

2. Postgres
   Managed PostgreSQL 16 runs in its own microVM and is auto-provisioned when an app needs a database and no DATABASE_URL is supplied.

3. S3-compatible Object Storage
   Buckets are S3-compatible with issued credentials; PutObject and GetObject are verified by canary. Other S3 operations are not verified.

Framework and Workload

• Framework: Gin
• Workload: REST API

Execution Status

• Status: Ready
• Release Status: Published
• Support Status: Verified

Prerequisites

• A Gin project that builds and starts with the documented commands (CGO_ENABLED=0 go build -o app ./... then ./app on the ubuntu-24.04 template (go.sum committed for a reproducible build)).
• A PostgreSQL driver reading DATABASE_URL at runtime (auto-provisioned when omitted, or supplied with --env).
• A bucket from ample bucket create with its credentials passed as encrypted S3_* environment variables.
• An Ample account token with servers:write, databases:read, and buckets:read.

Tested Configuration

• Template: ubuntu-24.04
• Runtime: go
• Size: s-1vcpu-1gb
• Build Command: CGO_ENABLED=0 go build -o app ./...
• Start Command: ./app

Input Schema

• env: Encrypted environment variables (bucket credentials, secrets)
• name: App name (1 to 63 characters, pattern: ^[a-z0-9-]+$)
• path: Project directory or ample.toml service (1 to 512 characters)
• release_command: Migration command run before activation

Workflow Steps

1. Build and Start
   CGO_ENABLED=0 go build -o app ./... then ./app on the ubuntu-24.04 template (go.sum committed for a reproducible build). The server must bind 0.0.0.0 on PORT.

2. Implement the Pattern on PostgreSQL
   The fixture's module implements generated downloads: an export query rendered to a CSV artifact stored with metadata in a private bucket and returned only to an authorized caller (401 without token, export=ok rows=3). Copy the approach into your schema; keep migrations idempotent and run them with --release-command.

3. Wire Object Storage
   Create the bucket(s), then pass endpoint, region, bucket, and keys as --env values. Use path-style addressing. Keep private data in an unpublished bucket.

4. Deploy
   Run the synchronous deployment once and read the result (exit 0 live, 1 failed, 2 blocked). Re-running with no change is a no-op.

   ample deploy . --name  --public --env S3_ENDPOINT=... --env S3_REGION=... --env S3_BUCKET=... --env S3_ACCESS_KEY_ID=... --env S3_SECRET_ACCESS_KEY=...
   

5. Verify
   Fetch the live URL and the pattern self-test route(s) (/p/generated-downloads) from the example; then run your own checks. On failure read ample logs --kind build then --kind runtime.

   ample logs  --kind build
   

Examples

• Gin Pattern Fixture
  Multi-pattern Gin app whose generated downloads module was checked live; the module is under tests/deploy-canaries/_pattern-modules.

Success Checks

1. App Responds on its Public URL

   • Kind: http_get
   • Path: /
   • Expect: ample canary gin patterns

2. Generated-Downloads Self-Test

   • Kind: http_get
   • Path: /p/generated-downloads
   • Expect: export=ok rows=3 (with ?token=...; 401 without)

Limitations

• Verified on the ubuntu-24.04 template at s-1vcpu-1gb with the example fixture; other sizes, templates, and Gin major versions are not verified.
• The REST API itself (your export formats, retention policy, and entitlement model) is application code and was not separately tested; the pattern checks are what was verified.

Cost Estimate

• Currency: USD
• Monthly Amount: 10.0
• Basis: Size prices from pricing.toml (loaded by the API) at build revision.
• Components:
  • App Server: 1.0 of size s-1vcpu-1gb, $5.0/month
  • Managed PostgreSQL Database: 1.0 of size s-1vcpu-1gb, $5.0/month
• Note: Always-on monthly price of the tested sizes; apps and databases auto-pause when idle. Buckets are allocation-priced per quota and not included.

Last Verified At: 2026-09-21T01:15:54Z

For more information, visit the documentation.

This content format is designed for developers looking to deploy a RESTful API using the Gin framework, along with step-by-step guidance for setup, execution, and considerations for production environments.