Endpoint Reference

Every category, section, and content item on your site is an artifact. Categories are roots; items are their children.

Addressing an artifact

The {slug} segment resolves by name first and falls back to the 16-character generated slug, so the name you set is the key you use everywhere. The integer id in responses is what content/save/ and the mapping endpoints need.

Adding an item to a category

Request

curl -X POST \
  -H "Authorization: Token $ENINE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "web-design", "title": "Web Design", "parent": "services",
       "content": "We build fast, accessible sites."}' \
  https://e9sites.com/api/v1/site/mysite.e9sites.com/artifacts/

Send parent or parent_pk to move an artifact later; an empty parent turns it back into a root. A name that is already used returns 409.

Changing one field

Request

curl -X PATCH \
  -H "Authorization: Token $ENINE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"type": "artifact", "pk": 2890, "fields": {"title": "Web and Product Design"}}' \
  https://e9sites.com/api/v1/site/mysite.e9sites.com/content/save/

The url field in a response is read-only: it is the resolved address of whatever the artifact links to. To change where an item points, create a catalogue entry and set link -- see Links.

Uploading is multipart/form-data on the field file, up to 10 MB per file. You can send several in one call.

Request

curl -X POST \
  -H "Authorization: Token $ENINE_TOKEN" \
  -F "file=@hero.png" \
  https://e9sites.com/api/v1/site/mysite.e9sites.com/media/

import os
import requests
with open("hero.png", "rb") as handle:
    response = requests.post(
        "https://e9sites.com/api/v1/site/mysite.e9sites.com/media/",
        files={"file": handle},
        headers={"Authorization": f"Token {os.environ['ENINE_TOKEN']}"},
    )
print(response.json())

Response

{
  "id": 42,
  "slug": "hero-png-a1b2c3",
  "filename": "hero.png",
  "file_type": "png",
  "is_image": true,
  "url": "https://.../hero.png",
  "filehash": "..."
}

Keep the id. Everywhere a file is referenced in a write, it is the integer id:

Request

curl -X POST -H "Authorization: Token $ENINE_TOKEN" -H "Content-Type: application/json" \
  -d '{"media": 42}' \
  https://e9sites.com/api/v1/site/mysite.e9sites.com/artifacts/web-design/

The same is true of logo, favicon, and hero_image inside a configure call. The slug is only for addressing the media row itself.

Creating a site

Request

curl -X POST \
  -H "Authorization: Token $ENINE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"domain": "mysite.e9sites.com", "name": "My Site"}' \
  https://e9sites.com/api/v1/site/

import os
import requests
payload = {"domain": "mysite.e9sites.com", "name": "My Site"}
response = requests.post(
    "https://e9sites.com/api/v1/site/",
    json=payload,
    headers={"Authorization": f"Token {os.environ['ENINE_TOKEN']}"},
)
print(response.status_code, response.json())

Response

{"domain": "mysite.e9sites.com"}

You get 201 on success and 409 if the domain is already taken.

The API gives you exactly what you asked for and nothing more: no sample content, no default hero image, no generated SEO pages. Those conveniences belong to the manager. If you want them here, ask for them explicitly.

Changing configuration

Request

curl -X POST \
  -H "Authorization: Token $ENINE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"theme": "print", "config": {"title": "My Site", "subtitle": "Built with the API"}}' \
  https://e9sites.com/api/v1/site/mysite.e9sites.com/configure/

Media fields inside config take the integer id of a media row -- see Media.

These are the API equivalents of the Export menu in the manager, which makes them the simplest way to back up a site on a schedule.

A nightly backup is one call:

Request

curl -H "Authorization: Token $ENINE_TOKEN" \
  "https://e9sites.com/api/v1/site/mysite.e9sites.com/?dl=json" \
  -o "mysite-$(date +%F).json"

Pushing content back:

Request

curl -X POST -H "Authorization: Token $ENINE_TOKEN" -H "Content-Type: application/json" \
  -d @mysite.json \
  https://e9sites.com/api/v1/site/mysite.e9sites.com/

import json
import os
import requests
headers = {"Authorization": f"Token {os.environ['ENINE_TOKEN']}"}
base = "https://e9sites.com/api/v1/site/mysite.e9sites.com"
site = requests.get(f"{base}/?dl=json", headers=headers).json()
with open("mysite.json", "w", encoding="utf-8") as handle:
    json.dump(site, handle, indent=2)

Two things to know. The format is chosen by the dl or output query parameter, never by an Accept header. And these endpoints are the exception to the usual response shape: they wrap their payload in success and data, where the rest of the API returns the resource directly.

Roles are reader, editor, and admin, and both username and role are required when adding someone.

Request

curl -X POST -H "Authorization: Token $ENINE_TOKEN" -H "Content-Type: application/json" \
  -d '{"username": "priya", "role": "editor"}' \
  https://e9sites.com/api/v1/site/mysite.e9sites.com/users/

Response

{"username": "priya", "email": "priya@example.com", "role": "editor", "job_title": ""}

These endpoints add accounts that already exist. Inviting somebody new by email address happens in the manager, not here. A username nobody holds returns 400 with the field named in errors, not 404 -- the site you addressed does exist, the value inside your payload is what is wrong.