API

Automate domains and aliases.

Use API keys to manage domains, aliases, and logs at scale. API access is available on Creator, Pro, and Business.

AuthBearer API key

Base URLhttps://forward.redsols.com/api

FormatJSON requests/responses

Get a key

Dashboard → API keys

Keys are shown once. Copy the value after creation and send it as a Bearer token.

Authorization: Bearer fwd_...your_key...

Authentication

Send your API key as a Bearer token in the Authorization header.

Authorization: Bearer fwd_...your_key...

Core endpoints

Domains

Create and manage domains.

POST /domains
GET /domains
DELETE /domains/{domain_id}
POST /domains/{domain_id}/verify

Returns 409 Domain already verified when the domain is already active.

Aliases

Create and update aliases.

POST /domains/{domain_id}/aliases
GET /domains/{domain_id}/aliases
PATCH /domains/{domain_id}/aliases/{alias_id}
DELETE /domains/{domain_id}/aliases/{alias_id}

Logs

Read inbound forwarding logs.

GET /logs

Quickstart

curl -X POST https://forward.redsols.com/domains   -H "Authorization: Bearer fwd_...your_key..."   -H "Content-Type: application/json"   -d '{"domain":"example.com"}'

curl -X POST https://forward.redsols.com/domains/<domain_id>/aliases   -H "Authorization: Bearer fwd_...your_key..."   -H "Content-Type: application/json"   -d '{"localpart":"hello","is_catch_all":false,"enabled":true,"destinations":["you@inbox.com"]}'

curl "https://forward.redsols.com/logs?limit=50"   -H "Authorization: Bearer fwd_...your_key..."

Payloads

Create domain

{
  "domain": "example.com"
}

Create alias

{
  "localpart": "hello",
  "is_catch_all": false,
  "enabled": true,
  "destinations": ["you@inbox.com", "team@company.com"]
}

Update alias

{
  "localpart": "support",
  "enabled": true,
  "destinations": ["support@company.com"]
}

Errors

{
  "detail": "Domain limit reached"
}

{
  "detail": "Invalid token"
}

API keys

Create

POST /api-keys

List

GET /api-keys

Delete

DELETE /api-keys/{key_id}