Galon Cloud
Galon API v1

/domains/{domain_id}

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

GET /domains/{domain_id}

Get a sending domain and its DNS records

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

Parameters

NameInTypeDescription
domain_idpathstring · required

Responses

StatusDescriptionBody
200Sending domainMailDomain
404Domain not found

Examples

curl

curl -X GET "$GALON_API_BASE/domains/<domain_id>" \
  -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.domains.get("<id>");

Python (SDK)

from galon import Galon

galon = Galon()  # reads GALON_API_KEY
result = galon.domains.get("<id>")

PATCH /domains/{domain_id}

Update the mutable options of a sending domain

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

Parameters

NameInTypeDescription
domain_idpathstring · required

Request body

application/json · schema MailDomainUpdate

FieldTypeDescription
tls"opportunistic" | "enforced"
custom_return_pathstring
open_trackingboolean
click_trackingboolean
bimiMailDomainBimi | null

Responses

StatusDescriptionBody
200Domain updatedMailDomain
404Domain not found
422Invalid parametersError

Examples

curl

curl -X PATCH "$GALON_API_BASE/domains/<domain_id>" \
  -H "Authorization: Bearer $GALON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tls": "opportunistic", "custom_return_path": "string", "open_tracking": true, "click_tracking": true}'

Node.js (SDK)

import { Galon } from "galon";

const galon = new Galon(process.env.GALON_API_KEY);
const result = await galon.domains.update("<id>", {"tls": "opportunistic", "custom_return_path": "string", "open_tracking": true, "click_tracking": true});

Python (SDK)

from galon import Galon

galon = Galon()  # reads GALON_API_KEY
result = galon.domains.update("<id>", {"tls": "opportunistic", "custom_return_path": "string", "open_tracking": True, "click_tracking": True})

DELETE /domains/{domain_id}

Delete a domain after exact confirmation

Confirmation in the Galon-Confirm header or the body {confirm}; destructive deletion.

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

Parameters

NameInTypeDescription
domain_idpathstring · required

Responses

StatusDescriptionBody
200Domain deletedMailDomainDeleteResponse
404Domain not found
409Active restricted keys
428Exact confirmation required

Examples

curl

curl -X DELETE "$GALON_API_BASE/domains/<domain_id>" \
  -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.domains.remove("<id>");

Python (SDK)

from galon import Galon

galon = Galon()  # reads GALON_API_KEY
result = galon.domains.remove("<id>")