Endpoints
These are the customer API endpoints. Every request uses https://control.stillorigin.app and your account API key. There is no endpoint that lists every domain in the account: look up one domain at a time, by ID or by name.
JSON field names are camelCase. originId may be null. IDs (accountId, domain id, clusterId, originId) are integers. The domain ID is the number in the portal page address, for example /domains/2050.
Your account
GET /v1/account returns the account the key belongs to, which key was used, and your Website protection licence counts. Use it to test the connection from your platform.
It has no parameters.
curl -sS https://control.stillorigin.app/v1/account \
-H "Authorization: Bearer $STILLORIGIN_API_KEY"
{"accountId": 12, "keySlot": "current", "l7": {"capacity": 5, "used": 3, "free": 2}}
| Field | Meaning |
|---|---|
accountId | The stillorigin account ID. |
keySlot | current, or previous when you used the old key during its 7-day overlap. |
l7.capacity | Your Website protection licences in total: one included with each licensed sentry, plus your in-date Website protection licences. |
l7.used | How many domains have Website protection on. |
l7.free | How many more domains can have Website protection turned on now. |
Look up a domain by ID
GET /v1/domains/{id} returns one domain in your account by its stillorigin ID — the number in the portal page address, for example /domains/2050. Use this when your platform already stores that ID.
curl -sS https://control.stillorigin.app/v1/domains/2050 \
-H "Authorization: Bearer $STILLORIGIN_API_KEY"
{"id": 2050, "name": "shop.example.com", "clusterId": 7, "originId": 31, "type": "wordpress", "l7Enabled": true, "l7LogMode": true}
| Field | Meaning |
|---|---|
id | The domain's stillorigin ID. |
name | The domain name as it is in stillorigin. |
clusterId | The cluster the domain is in. |
originId | The origin server, or null if the domain has none. |
type | generic, wordpress, drupal or joomla. |
l7Enabled | true when Website protection is on. |
l7LogMode | true when the Website protection rules are in log mode and only record what they would block. |
The API doesn't return whether HTTPS is inspected.
Look up a domain by name
GET /v1/domains?domain=example.com returns one domain in your account by name. Use this when your billing system or CRM knows the customer's domain name but not its stillorigin ID.
An exact name wins; otherwise a www. name finds its pair, so www.shop.example.com finds shop.example.com and the other way round. The domain parameter is required. Omitting it, giving an empty name, or a name that can't be a domain (empty after normalising, longer than 253 characters, or containing a space, /, \, @, :, ? or #) returns 400 with error invalid_request.
curl -sS "https://control.stillorigin.app/v1/domains?domain=shop.example.com" \
-H "Authorization: Bearer $STILLORIGIN_API_KEY"
The response is the same domain object as look up by ID.
Find a domain's sentries
GET /v1/domains/{id}/sentries returns the licensed sentries that serve one domain in your account, and the addresses its DNS should point at. Use this when your platform sets a customer's DNS, or moves a site onto stillorigin.
You can also look the domain up by name with GET /v1/domains/sentries?domain=example.com. The name works the same way as look up by name, including the www. pair.
curl -sS https://control.stillorigin.app/v1/domains/2050/sentries \
-H "Authorization: Bearer $STILLORIGIN_API_KEY"
curl -sS "https://control.stillorigin.app/v1/domains/sentries?domain=shop.example.com" \
-H "Authorization: Bearer $STILLORIGIN_API_KEY"
{
"domainId": 2050,
"name": "shop.example.com",
"clusterId": 7,
"clusterName": "edge-syd",
"vip": null,
"dns": {"a": ["198.51.100.21", "198.51.100.22"], "aaaa": ["2001:db8::21"]},
"sentries": [
{"id": 41, "clusterId": 7, "clusterName": "edge-syd", "publicIpv4": "198.51.100.21", "publicIpv6": "2001:db8::21", "online": true, "lastSeen": "2026-11-16T08:04:12+00:00"},
{"id": 42, "clusterId": 7, "clusterName": "edge-syd", "publicIpv4": "198.51.100.22", "publicIpv6": null, "online": false, "lastSeen": "2026-11-16T07:31:40+00:00"}
]
}
| Field | Meaning |
|---|---|
domainId | The domain's stillorigin ID. |
name | The domain name as it is in stillorigin. |
clusterId | The cluster the domain is in. |
clusterName | The cluster's name, for display only. Match on clusterId, because names can change. |
vip | The cluster's floating IP address, or null if the cluster doesn't have one. |
dns.a | The IPv4 addresses to use in the domain's A records. |
dns.aaaa | The IPv6 addresses to use in the domain's AAAA records. Empty if none. |
sentries | Every licensed sentry in the domain's cluster, in ID order. A domain is in exactly one cluster. |
sentries[].id | The sentry's stillorigin ID. |
sentries[].clusterId | The same cluster as clusterId. |
sentries[].clusterName | The same name as clusterName, for display only. |
sentries[].publicIpv4 | The public IPv4 address the sentry last reported, or null if it hasn't reported a valid one. |
sentries[].publicIpv6 | The public IPv6 address the sentry last reported, or null. |
sentries[].online | true when the sentry has checked in during the last 10 minutes, the same window as in the portal. |
sentries[].lastSeen | When the sentry last checked in, as a UTC timestamp, or null if it never has. |
- If the cluster has a VIP,
dnslists only the VIP. Otherwise it lists every sentry's reported addresses, each once, with one A record per sentry as in Point DNS at your sentries. - A sentry that is offline stays in
dns. Round-robin DNS doesn't check whether a sentry is healthy, so useonlineif you want to leave a failed sentry out until it's back. - A sentry that hasn't reported its address yet is listed in
sentrieswithnulladdresses, and isn't indns. - The response never includes licence keys or other secrets.
Errors are the same as for looking up a domain: 404 with error domain_not_found when the domain isn't in your account, and 400 with invalid_request for a name that can't be a domain. These calls count towards the same rate limit as the other domain endpoints.
Get a domain's summary
GET /v1/domains/{id}/summary returns a read-only summary of one domain in your account: its protection level, its Website protection mode, whether Captcha Protection is checking visitors, and its last 24 hours. Use it to show your customers how their site is protected, for example in your billing system's client area. The WHMCS module uses it.
curl -sS https://control.stillorigin.app/v1/domains/2050/summary \
-H "Authorization: Bearer $STILLORIGIN_API_KEY"
{
"domainId": 2050,
"name": "shop.example.com",
"protection": "website",
"websiteMode": "log",
"underAttack": false,
"captchaSome": true,
"last24h": {
"allowed": 12345,
"blocked": 67,
"checksShown": 9,
"checksPassed": 8,
"checksFailed": 1,
"topReasons": [{"code": "so-rate", "label": "Rate limit", "count": 40}]
},
"generatedAt": "2026-11-17T00:00:00+00:00"
}
| Field | Meaning |
|---|---|
domainId | The domain's stillorigin ID. |
name | The domain name as it is in stillorigin. |
protection | website (Website protection is on) or network (Network protection only). |
websiteMode | log (log mode) or blocking. null with Network protection. |
underAttack | true when Captcha Protection checks every visitor (Under Attack). |
captchaSome | true when Captcha Protection checks some visitors, and Under Attack is off. |
last24h.allowed, last24h.blocked | Requests allowed and blocked in the last 24 hours, the same numbers as the domain's page in the portal. |
last24h.checksShown, checksPassed, checksFailed | Browser checks shown, passed and failed in the last 24 hours. 0 with Network protection. |
last24h.topReasons | Up to 3 block reasons, most first: the code as in the logs, a plain-words label, and the count. |
generatedAt | When the summary was made, as a UTC timestamp. |
The summary never includes IP addresses, keys or other secrets. It's by ID only. Find the ID first with look up by name. Errors are the same as for looking up a domain, and it counts towards the same rate limit. The numbers change slowly, so if you show them to customers, keep a copy for a few minutes rather than asking on every page load.
Turn Website protection on or off
POST /v1/domains/l7 turns Website protection on or off for one domain, the same as in the portal. Use it when a customer orders Website protection in your own platform, or when they cancel.
The request needs Content-Type: application/json. The body has enabled (true or false) and exactly one of:
domainId: the domain's ID (preferred), for example{"domainId": 2050, "enabled": true};domain: the domain name (awww.pair works), for example{"domain": "shop.example.com", "enabled": false}.
enabled is required. If it's missing, the API returns 400 with error invalid_request and the detail Set enabled to true or false. If you send both domainId and domain, or neither, that's also 400 with invalid_request.
When you turn Website protection on from off, you can also send l7LogMode. true or omitted starts the domain in log mode; false starts blocking. l7LogMode is ignored when you turn Website protection off, or when the domain is already in the state you asked for.
Turn Website protection on, starting in log mode:
curl -sS https://control.stillorigin.app/v1/domains/l7 \
-H "Authorization: Bearer $STILLORIGIN_API_KEY" \
-H "Content-Type: application/json" \
-d '{"domainId": 2050, "enabled": true}'
To start blocking instead of log mode, send {"domainId": 2050, "enabled": true, "l7LogMode": false}. To turn Website protection off: {"domain": "shop.example.com", "enabled": false}.
A successful request returns 200 with the domain after the change:
{"changed": true, "domain": {"id": 2050, "name": "shop.example.com", "clusterId": 7, "originId": 31, "type": "wordpress", "l7Enabled": true, "l7LogMode": true}}
- Turning Website protection on uses a free Website protection licence: the Website protection licence included with a licensed sentry, or else an unassigned Website protection licence. If no place is free, the API returns
409witherrorno_l7_placeand nothing changes. - Turning Website protection off returns its licence. Owner settings are kept.
l7LogModeis ignored. - The cluster's sentries pick up the change within a minute.
- Asking for the state the domain already has is safe. It returns
200with"changed": false, and nothing is changed or recorded in the audit log, even if you sendl7LogMode. - Each real change appears in your audit log, made by API key, with the caller's IP and whether the current or previous key was used.
Owner sign-in links
POST /v1/owner-logins creates a one-time sign-in link to the owner area for one Website protection domain. Use it from your own client area: when the customer asks to manage their site's protection, your server creates the link and sends their browser to it.
The request needs Content-Type: application/json. The body has exactly one of domainId or domain (no enabled field):
curl -sS https://control.stillorigin.app/v1/owner-logins \
-H "Authorization: Bearer $STILLORIGIN_API_KEY" \
-H "Content-Type: application/json" \
-d '{"domainId": 2050}'
You can also authorise with an origin agent key. An agent key only works for domains on that agent's origin servers. An agent key is rejected on GET /v1/account and the domains endpoints.
A successful request returns 200:
{
"url": "https://owners.stillorigin.app/login/sol_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"expiresAt": "2026-11-16T08:05:00.0000000+00:00",
"domainId": 2050
}
urlis the sign-in link. It works once, and only its hash is stored. Treat it like a password: don't log it, email it or store it.expiresAtis when the link stops working, in UTC, 5 minutes after it was made.domainIdis the domain the link is for.
The domain must already have Website protection on; otherwise the API returns 409 with error not_l7. A successful request is recorded in your audit log.
Once the customer has signed in, the owner session lasts 30 minutes idle or 8 hours at most. That's the owner area, not your API key. See Domain owner access for sessions, and Creating sign-in links with the API for an example of a button in your client area.
Errors for this endpoint use a different JSON shape. See Rate limits and errors.
Latest component versions
GET /v1/components/latest returns the latest release of each part of stillorigin you install yourself: whmcs (the WHMCS module) and agent (the origin agent, which carries the WHM and cPanel plugins). Add ?component=whmcs for one only. The WHMCS module uses it for its update notice.
curl -sS "https://control.stillorigin.app/v1/components/latest?component=whmcs" \
-H "Authorization: Bearer $STILLORIGIN_API_KEY" \
-H "X-Stillorigin-Client: whmcs/1.0.0"
{
"components": [
{
"component": "whmcs",
"version": "1.1.0",
"releasedOn": "2026-11-17",
"severity": "minor",
"changelogUrl": "https://kb.stillorigin.app/changelog#whmcs-1-1-0",
"downloadUrl": "https://control.stillorigin.app/downloads/stillorigin-whmcs.zip",
"updatesItself": false,
"installed": "1.0.0",
"updateAvailable": true
}
]
}
| Field | What it is |
|---|---|
version | The latest version. |
releasedOn | Its release date, or null when not known. |
severity | minor, security (fixes a security issue) or breaking (changes how it works). With installed, the most serious release you haven't installed yet. |
changelogUrl, downloadUrl | What's new, and where to download it. downloadUrl is empty for components that update themselves. |
updatesItself | true for the origin agent, which installs new versions by itself. |
installed, updateAvailable | Only when your call sends X-Stillorigin-Client: <component>/<version> for that component: the version you sent, and whether it's older than version. |
An unknown component returns 400 with error invalid_request. The call counts towards the usual rate limit. Releases don't change often, so keep the answer for at least 10 minutes.