Galon Cloud
Galon API v1

/deploy/journeys

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

GET /deploy/journeys

List preview deployments

Scope job:read. Served only when Galon Deploy is open to the account (404 otherwise). Errors {"detail": {"code"}}.

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

Parameters

NameInTypeDescription
limitqueryinteger

Responses

StatusDescriptionBody
200Recent deployments (galon.deploy.journeys.v1)object
401Key missing or invalidError

Examples

curl

curl -X GET "$GALON_API_BASE/deploy/journeys" \
  -H "Authorization: Bearer $GALON_API_KEY"

Node.js (SDK)

import { Galon } from "galon";

const galon = new Galon(process.env.GALON_API_KEY);
const result = await galon.deployments.list({ limit: 20 });

Python (SDK)

from galon import Galon

galon = Galon()  # reads GALON_API_KEY
result = galon.deployments.list({"limit": 20})

POST /deploy/journeys

Start a preview deployment

Scope deploy:create. Served only when Galon Deploy is open to the account (404 otherwise). Errors {"detail": {"code"}}. One step at a time: advance with POST /deploy/journeys/{journey_id}/resume. 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
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
intentionobject · required
expires_atstring · required

Responses

StatusDescriptionBody
201Deployment createdobject
200Idempotent replayobject
429deploy_quota_daily_exceededError
401Key missing or invalidError

Examples

curl

curl -X POST "$GALON_API_BASE/deploy/journeys" \
  -H "Authorization: Bearer $GALON_API_KEY" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{"intention": {"installation_ref": "string", "repository": "string", "commit_sha": "string", "root_path": "string"}, "expires_at": "2026-11-11T12:00:00Z"}'

Node.js (SDK)

import { Galon } from "galon";

const galon = new Galon(process.env.GALON_API_KEY);
const result = await galon.deployments.create({"intention": {"installation_ref": "string", "repository": "string", "commit_sha": "string", "root_path": "string"}, "expires_at": "2026-11-11T12:00:00Z"}, { idempotencyKey: "<unique-key>" });

Python (SDK)

from galon import Galon

galon = Galon()  # reads GALON_API_KEY
result = galon.deployments.create({"intention": {"installation_ref": "string", "repository": "string", "commit_sha": "string", "root_path": "string"}, "expires_at": "2026-11-11T12:00:00Z"}, idempotency_key="<unique-key>")