Galon Cloud
Galon API v1

API reference

Every path of the Galon OpenAPI 3.1 contract, rendered from the contract itself. Base URL: https://api.galon.ai/v1. Machine-readable: openapi.json · limits: Limits and quotas.

Tools

GET/toolsList tools authorised by the key
GET/projects/{project_id}/toolsRegistry tools available to the project from the console

Projects

GET POST/projectsList the tenant's projects
GET POST/projects/{project_id}/keysList metadata of the project's keys
POST/projects/{project_id}/keys/{key_id}/revokeRevoke an API key immediately
GET/usageMeasurable usage from the console (what is not measured is named)
GET/console/preferencesAccount language set for the console (empty if no explicit setting)
GET/console/available-scopesScopes a key can receive: services that work for this account (registry tools and companions)
GET/projects/{project_id}/keys/vaultSecure copy: vault configured, copyable keys
POST/projects/{project_id}/keys/{key_id}/copyCopy the secret of a sealed key after re-authentication (never cached, logged)
PATCH/projects/{project_id}/keys/{key_id}Change a key's scopes (same identifier, same secret), or rename it (body {name} only)

Jobs

POST/jobsSubmit a job
GET/jobs/{job_id}Get a job
POST/jobs/{job_id}/cancelCancel a job
GET/projects/{project_id}/jobs/{job_id}Get a job from the console
GET/projects/{project_id}/jobsList the project's jobs from the console (paginated, status filter)
POST/projects/{project_id}/jobs/{job_id}/cancelCancel a job from the console (idempotent: a finished job returns its state)

Builds

POST/buildsBuild a web application
GET/builds/{job_id}Get a build
POST/builds/{job_id}/cancelCancel a build before it starts
GET/builds/{job_id}/artifactsList a build's artefacts

Mail

GET POST/projects/{project_id}/mail/onboardingLoad or start Galon Mail onboarding
POST/projects/{project_id}/mail/checkoutCreate or resume payment for a Galon Mail product
POST/projects/{project_id}/mail/freeActivate the Galon Mail free tier
GET/projects/{project_id}/mail/subscriptionGet the Galon Mail subscription status
GET/projects/{project_id}/mail/subscriptionsGet Transactional and Marketing subscriptions
POST/projects/{project_id}/mail/subscription/cancelStop renewal of a Mail product (the plan remains active until the end of the paid period)
GET POST/terms/acceptanceAcceptance status of the current terms
POST/mail/consentsRecord a recipient's marketing consent
POST/mail/consents/revokeRevoke a marketing consent
GET POST/emailsList the project's email log
GET/emails/metricsGet daily log metrics over at most 92 days
GET/emails/bounce-reasonsProject bounce reasons over 7 or 30 days
GET/deliverabilityDeliverability by mailbox provider for the key's project (Gmail, Microsoft, Yahoo/AOL, Apple, Orange, others) over 7 and 30 days
GET/projects/{project_id}/mail/deliverabilityDeliverability by mailbox provider for the project (console)
POST/emails/batchSend a batch of emails
POST/emails/{job_id}/cancelCancel a send still queued (scheduled or not)
GET PATCH/emails/{email_id}Get an email and its retained timeline
GET POST/templatesList the project's templates
GET PATCH DELETE/templates/{template}Get a template's draft and published state
POST/templates/{template}/publishPublish an immutable version of the draft
POST/templates/{template}/duplicateDuplicate the draft into a new unpublished template without an alias
POST/domains/claimClaim a domain already registered by another account (DNS proof): returns the TXT record to publish; no information about the holder
GET/domains/claims/{claim_id}Get a domain claim
POST/domains/claims/{claim_id}/verifyCheck the TXT record and conclude: transferred (a NEW identity, to be verified, in the project) or blocked (domain active on another account)
POST/email-validationsValidate email addresses (syntax, role, disposable domain, typo, MX)
GET POST/domainsList Galon Mail sending domains
GET PATCH DELETE/domains/{domain_id}Get a sending domain and its DNS records
POST/domains/{domain_id}/verifyRe-check a domain's DNS records
GET/projects/{project_id}/mail/statusGalon Mail for this account: armed, sending mode, identity, DNS records, payment available
POST/projects/{project_id}/mail/dns/verifyCheck the sending domain's DNS records now (public DNS observed, re-read requested from the sending service); 1 call per minute per tenant
GET/console/mail-requirementsConsole help: sending requirements enforced by Galon Mail (Markdown)
GET POST/suppressionsList the suppression list
DELETE/suppressions/{target}Remove an address from the suppression list
GET/received-emailsList received emails
GET/received-emails/{email_id}Get a received email
GET/received-emails/{email_id}/attachmentsList a received email's attachments
GET/received-emails/{email_id}/attachments/{attachment_id}Download an attachment
POST/received-emails/{email_id}/forwardForward a received email
GET POST/receiving-domainsList inbound domains
GET PATCH DELETE/receiving-domains/{domain_id}Get an inbound domain
GET POST/receiving-domains/{domain_id}/rulesList a domain's forwarding rules
PATCH DELETE/receiving-domains/{domain_id}/rules/{rule_id}Enable or disable a forwarding rule
GET POST/mail-pro/domainsList Mail Pro domains
GET DELETE/mail-pro/domains/{domain_id}Get a Mail Pro domain
POST/mail-pro/domains/{domain_id}/verifyVerify a Mail Pro domain
GET POST/mail-pro/mailboxesList Mail Pro mailboxes
GET PATCH DELETE/mail-pro/mailboxes/{mailbox_id}Get a Mail Pro mailbox
POST/mail-pro/mailboxes/{mailbox_id}/suspendSuspend a mailbox
POST/mail-pro/mailboxes/{mailbox_id}/resumeReactivate a mailbox
POST/mail-pro/mailboxes/{mailbox_id}/aliasesAdd an alias to a mailbox
DELETE/mail-pro/mailboxes/{mailbox_id}/aliases/{address}Remove an alias
POST/mail-pro/mailboxes/{mailbox_id}/passwordChange a mailbox's password
POST/mail-pro/mailboxes/{mailbox_id}/activation-linkSend an activation link
POST/mail-pro/domains/{rid}/storageBuy storage for a domain

Domains

GET/projects/{project_id}/domainsList the domain portfolio from the console
GET/projects/{project_id}/domain-quotes/{quote_id}Re-read a domain quote from the console
GET/projects/{project_id}/domain-ordersList domain orders from the console
GET/projects/{project_id}/domain-noticesList expiry notices from the console
POST/projects/{project_id}/domain-notices/{notice_id}Mark an expiry notice
POST/projects/{project_id}/domain-orders/{order_id}/refund-requestsRequest a refund review
POST/projects/{project_id}/domains/lookupCheck a domain from the console
POST/projects/{project_id}/domains/queryRequest a quote, the status or the DNS from the console
POST/projects/{project_id}/domains/actionsConfirm an exact domain action from the console
GET/domain-portfolioList the portfolio of the key's project
GET/domain-quotes/{quote_id}Re-read a quote of the key's project
GET/domain-ordersList orders of the key's project
POST/projects/{project_id}/domain-transfers/checkCheck eligibility for an inbound transfer
GET POST/projects/{project_id}/domain-transfersTrack inbound transfers
GET/projects/{project_id}/domains/{domain}/email-verificationGet the holder's email verification
POST/projects/{project_id}/domains/{domain}/transfer-outPrepare an outbound transfer
GET/projects/{project_id}/domains/{domain}/renewalGet a domain's renewal
PUT/projects/{project_id}/domains/{domain}/auto-renewTurn automatic renewal on or off
POST/projects/{project_id}/domains/{domain}/renewalsRenew now
GET POST/projects/{project_id}/dns/zonesList DNS zones hosted by Galon
DELETE/projects/{project_id}/dns/zones/{domain}Delete a DNS zone

Webhooks

GET/webhook-eventsList event types
GET POST/projects/{project_id}/webhooksList endpoints
PATCH/projects/{project_id}/webhooks/{endpoint_id}Update an endpoint's URL, events or state
POST/projects/{project_id}/webhooks/{endpoint_id}/rotate-secretRotate the signing secret with a 24-hour overlap
POST/projects/{project_id}/webhooks/{endpoint_id}/disableDisable an endpoint
GET/projects/{project_id}/webhook-deliveriesList deliveries
POST/projects/{project_id}/webhook-deliveries/{delivery_id}/replayReplay a terminal delivery

Billing

GET/billing/subscriptionsSubscriptions of all the organisation's projects
GET PUT/billing/detailsBilling details
GET/billing/invoicesGalon invoices issued by GALON AI LTD
GET/billing/invoices/{invoice_id}/pdfPDF of an invoice (amount = price paid, no tax line)
GET PUT/billing/budgetMonthly budget and alert thresholds
GET/billing/payment-methodCard saved for subscriptions (display only)
POST/billing/payment-method/updateOpen the card update (secure payment page)
GET/billing/usage.csvCSV export for the month (invoices and sending counters)
POST/sales/contactContact the sales team
GET/billing/payment-methodsPayment methods offered for a billing country

Usage

GET/costsGet the recognised monthly spend of the project bound to the key
GET/meteringGet technical quantities recorded for the project bound to the key
GET/limitsGet limits and consumption of the project bound to the key

Storage

GET POST/projects/{project_id}/storage/bucketsConsole — List the project's buckets
GET/projects/{project_id}/storage/buckets/{bucket_id}Console — Get a bucket
POST/projects/{project_id}/storage/buckets/{bucket_id}/uploadsConsole — Start a direct upload (begin)
POST/projects/{project_id}/storage/uploads/{upload_id}/commitConsole — Validate an upload (commit)
GET/projects/{project_id}/storage/buckets/{bucket_id}/objectsConsole — List objects in a bucket
GET DELETE/projects/{project_id}/storage/objects/{object_id}Console — Get an object's metadata
GET/projects/{project_id}/storage/usageConsole — Get the project's Storage usage
GET POST/storage/bucketsList buckets of the project bound to the key
GET/storage/buckets/{bucket_id}Get a bucket
POST/storage/buckets/{bucket_id}/uploadsStart a direct upload (begin)
POST/storage/uploads/{upload_id}/commitValidate an upload (commit)
GET/storage/buckets/{bucket_id}/objectsList objects in a bucket
GET DELETE/storage/objects/{object_id}Get an object's metadata
GET/storage/usageGet Storage usage of the project bound to the key
GET/storage/objects/{object_id}/versionsList an object's versions
POST/storage/objects/{object_id}/restoreRestore an earlier version
POST/storage/objects/{object_id}/linksCreate a time-limited signed link
GET/storage/usage/historyGet Storage usage history
GET PUT/storage/tierGet the project's Storage tier
GET PUT/storage/buckets/{bucket_id}/accessGet a bucket's public access

AI

POST/ai/chat/completionsGenerate a response (chat completions compatible)
GET/ai/modelsList served models
POST/ai/embeddingsCompute embeddings

Deploy

POST/deploy/archivesDeploy a static site from an archive (preview)
GET POST/deploy/journeysList preview deployments
GET/deploy/journeys/{journey_id}Get a deployment
POST/deploy/journeys/{journey_id}/resumeAdvance a deployment by one step
GET/deploy/journeys/{journey_id}/build-logsGet the build log
GET/deploy/runtime/{instance_id}/logsGet the runtime log (server rendering)
GET/deploy/envGet environment variables
GET/deploy/production/plansList production plans
GET/deploy/production/statusGet the production status
POST/deploy/production/planChoose a production plan
POST/deploy/production/domainsAttach a custom domain
POST/deploy/production/domains/{domain}/verifyVerify a custom domain
DELETE/deploy/production/domains/{domain}Detach a custom domain
POST/deploy/production/promotePromote a preview to production
POST/deploy/production/rollbackRoll back to the previous release
DELETE/deploy/journeys/{journey_id}/previewDelete a preview

Geo

GET/geo/geocodeGeocode an address or GPS text
GET/geo/autocompleteSuggest addresses as the user types
GET/geo/reverseFind the address of a point
GET/geo/places/searchSearch places around a point
POST/geo/routeCompute a route
POST/geo/matrixCompute a distance matrix
POST/geo/isochroneCompute a reachable area
GET/geo/styles/basemapGet the map style
GET/geo/tiles/{z}/{x}/{y}.mvtGet a vector tile
GET/geo/fonts/{fontstack}/{range}.pbfGet map label glyphs
GET/geo/sprites/{file}Get map icons
GET POST/projects/{project_id}/keys/browserList the browser keys of a project
PATCH/projects/{project_id}/keys/browser/{key_id}Change a browser key
POST/projects/{project_id}/keys/browser/{key_id}/revokeRevoke a browser key
POST/projects/{project_id}/keys/browser/{key_id}/copyCopy a browser key
POST/search/v2/scrapeRead one web page as Markdown
POST/search/v2/mapList a site's page addresses
POST/search/v2/crawlStart a crawl job (read a site)
GET DELETE/search/v2/crawl/{crawl_id}Read a crawl job: status and pages
GET/search/v2/crawl/{crawl_id}/errorsPages a crawl job could not read
GET POST/search/indexesList search indexes
GET DELETE/search/indexes/{name}Read a search index
POST/search/indexes/{name}/documentsAdd or update documents
POST/search/indexes/{name}/querySearch an index
GET/search/indexes/{name}/documents/{document_id}Read a document
POST/search/indexes/{name}/documents/deleteDelete documents
GET/search/tasks/{task_id}Read a search task

Compute

GET/compute/flavorsList machine sizes
GET/compute/imagesList machine images
GET POST/compute/ssh-keysList SSH keys
POST/compute/quotesQuote a machine
GET POST/compute/instancesList machines
GET DELETE/compute/instances/{instance_id}Read a machine
POST/compute/instances/{instance_id}/startStart a machine
POST/compute/instances/{instance_id}/stopStop a machine
POST/compute/instances/{instance_id}/rebootReboot a machine
GET/compute/usageMachine usage

Functions

GET/functions/pricingRead Functions prices
POST/functions/sourcesUpload a function source
POST/functions/deploymentsDeploy a function
GET/functions/jobs/{job_id}Read a function job
POST/functions/deletionsDelete a function revision

Backend

GET/backend/databasesList databases
POST/backend/hosted/databasesCreate a hosted database
GET/backend/databases/{database_id}Read a database
POST/backend/databases/{database_id}/migrationsApply SQL migrations
GET/backend/operations/{operation_id}Read a database operation