Galon Cloud
Galon API v1

/deploy/archives

Base URL https://api.galon.ai/v1 · export GALON_API_BASE="https://api.galon.ai/v1"

POST /deploy/archives

Deploy a static site from an archive (preview)

Scope deploy:create, TEST key only (a live key gets 404 not_found). Served only when Galon Deploy archives are enabled for the account (404 otherwise). Send the files as JSON (files or archive_base64) or the raw archive (zip, tar, tar.gz: the format is read from the file signature). index.html is required at the root; a single top-level folder holding index.html is stripped. Bounds: 25 MiB uploaded, 512 files, 2 MiB per file, 10 MiB in total, 40 MiB decompressed; links, devices, absolute paths, .. and .git are refused. Then advance the returned journey with POST /deploy/journeys/{journey_id}/resume until status is ready. Errors {"detail": {"code"}}. Send `Prefer: wait=20` on `POST /v1/deploy/archives` or `/journeys`: the steps run inside the request (20 s at most) and the response carries the preview, its `preview_access_token` and `wait.outcome`; if `outcome` is not `ready`, continue with `…/resume`.

API key (Bearer), on the public API endpoint.

Parameters

NameInTypeDescription
Idempotency-Keyheaderstring · required
expires_atquerystringRaw archive bodies only (a JSON body carries expires_at in the body and accepts no query).
Preferheaderstringwait=N (1 to 30 seconds, 25 recommended): run the deploy steps inside the request and return the preview when ready.

Request body

application/json

FieldTypeDescription
filesobjectRelative path -> UTF-8 text content. index.html is required at the root.
archive_base64stringA zip, tar or tar.gz archive, base64-encoded.
expires_atstringPreview expiry, UTC with Z, at most 7 days ahead. Default: 00:00 UTC four days after today.

Responses

StatusDescriptionBody
201Archive accepted, preview journey createdobject
200Idempotent replayobject
400idempotency_key_invalid, content_length_invalid, body_invalid, body_fields_invalid, query_invalidError
401Key missing or invalidError
403scope_missing, deploy_tenant_not_allowed, journey_source_not_connectedError
404not_found (live key, or Deploy archives not open to the account)Error
409idempotency_conflict, deploy_journey_conflictError
413deploy_archive_too_large, deploy_archive_too_many_files, deploy_archive_file_too_large, deploy_archive_content_too_largeError
415content_type_invalidError
422deploy_archive_format_invalid, deploy_archive_path_invalid, deploy_archive_link_refused, deploy_archive_entry_refused, deploy_archive_duplicate_path, deploy_archive_index_missing, deploy_archive_empty, journey_preview_expiry_invalid, journey_timestamp_invalidError
429deploy_archive_quota_exceeded (Retry-After: 3600), deploy_quota_daily_exceededError
503deploy_auth_unavailable, deploy_archive_storage_unavailable, deploy_archive_storage_not_configured, deploy_temporarily_unavailableError
507deploy_archive_storage_fullError

Examples

curl

curl -X POST "$GALON_API_BASE/deploy/archives" \
  -H "Authorization: Bearer $GALON_API_KEY" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d 'null'