Skip to main content

Using the API

If you run your own billing system, CRM or client area, the stillorigin API lets your platform work with your stillorigin account. Typical uses are:

  • look up a customer's domain in stillorigin;
  • turn Website protection on when they order it, or off when they cancel;
  • find which sentries serve a domain, and the IP addresses its DNS should point at;
  • give them a one-time sign-in link to the owner area from your own client area.

You call the API from your own server with your account API key. Build your own integration walks through the same flow the WHMCS module uses: test the key, look up a domain, turn Website protection on or off, and create a one-time owner sign-in link. If you use WHMCS, that module already does this for you. On cPanel, the cPanel plugin creates owner sign-in links with the origin agent's key.

Base URL​

All requests go to:

https://control.stillorigin.app/v1

The API is HTTPS only.

Authentication​

There is one API key for the whole stillorigin account, not a key per user. It has no separate permissions: anyone with the key can look up domains, turn Website protection on or off, and create owner sign-in links for any Website protection domain in the account.

Only an account owner can create or replace it, under My account › API key (open My account from the menu at the bottom of the sidebar). stillorigin doesn't keep a readable copy of the key, so it is shown only once, when you create it. Keep it in a password manager, and only on your server. Never put it in browser code, a page's HTML or a mobile app.

Send it as a Bearer token with every request:

Authorization: Bearer YOUR_API_KEY
  • Origin agent keys don't work on the account and domains endpoints. They can create owner sign-in links for domains on that agent's origin servers. See Owner sign-in links.
  • Every request only sees your own account. A domain in another account is reported as not found.

Creating a new key​

The current key does not expire.

When you create a new key, tick Keep the old key working for 7 days, so I can update my sentries (ticked by default). The previous key keeps working for 7 days, so you can put the new key on your sentries and in your own platform. You can end that early with Stop the old key now. If you leave the box unticked, the old key stops working at once.

During the overlap, both keys work. GET /v1/account tells you which one you used in keySlot: current or previous.

If a key leaks, create a new one and update your sentries and your platform. See Putting a new API key on your sentries.

What you can do​

RequestWhat it does
GET /v1/accountYour account and its Website protection licences. Use it to test your key.
GET /v1/domains/{id}One domain, by its stillorigin ID.
GET /v1/domains?domain=example.comOne domain, by name.
GET /v1/domains/{id}/sentries or GET /v1/domains/sentries?domain=The sentries that serve one domain, and the addresses its DNS should point at.
GET /v1/domains/{id}/summaryOne domain's protection and its last 24 hours, read-only.
POST /v1/domains/l7Turn Website protection on or off for one domain.
POST /v1/owner-loginsA one-time owner sign-in link.

Request and response examples are on Endpoints. Rate limits and errors covers limits and error codes.

What the API doesn't include​

There is no API to:

  • list all domains, or list every sentry, origin, licence or audit event in the account (you can look up the sentries for one domain);
  • add, edit or remove sentries, origins or domains (except turning Website protection on or off);
  • read or change deny lists, allow lists or country rules;
  • read traffic, blocks or maps, other than one domain's 24-hour summary;
  • manage licences or billing;
  • check or delist the stillorigin naughty list — that is a public flow on stillorigin.app, not this API (see Delisting an IP address);
  • register webhooks.

There is no official SDK, OpenAPI description or sandbox. You call the HTTPS API directly, for example with curl or from your own code.