Skip to main content

In your app

A controller answers a route on your app: it calls publishBlog() and returns the answer.

Add the controller

app/controllers/publish_blog_controller.ts

Add the route

start/routes.ts
Put it behind your auth middleware (.use(middleware.auth())): it acts with your key’s access.

Call it

Your own page’s form or script sends POST /blog/clx8m2k4p0000a1b2c3d4e5f6/publish and gets back its answer as JSON. Test it, below, calls it.
Answers the draft.

Find the id

id is the document’s _id, from a list. Ask the list for only the fields you need: each row is a document’s id and those fields.
AdonisJS
Pass row.id as id. Drafts: list with { aposMode: 'draft' } to get the draft’s id (Find an id).

Required parameters

One object, e.g. publishBlog({ id }); leave out the optional fields.
string
required
Required. The document’s _id: a full id names its own locale and mode (the draft’s …:en:draft, the published one’s …:en:published; no aposMode needed), a bare aposDocId takes the request’s (aposLocale, aposMode).
A Blog. Blog content type. Read its properties (blog.title): each says whether the site always sends it. The example answer is the site’s wire JSON: some keys differ from the property names (_id → id, _author → author, _category → category …).
string
Always sent. Its title: the name it goes by in every list, and the heading of its page where it has one.
Date
Always sent. The post’s publication date (YYYY-MM-DD, e.g. 2026-10-21): the date it shows, and its place in the blog list, newest first. Format: an ISO 8601 date (YYYY-MM-DD).
string
Always sent. The document’s id. On a type with drafts it ends in its locale and mode (…:en:published, …:en:draft): the part before the first colon is its aposDocId, shared by both copies. The {_id} the type’s routes take.
string
Always sent. The document type’s name: always this type’s.
readonly Readonly<Record<string, unknown>>[] | null
Sometimes sent: undefined when the site leaves it out, and it can be null. Credited author. Pick from the Authors collection — their profile photo shows alongside the post. The related author documents, in order (empty when none). To set it, send a list of { "_id": "…" }, one per document (one at most); a document the site can’t find is left out. At most 1 items.
readonly Readonly<Record<string, unknown>>[] | null
Sometimes sent: undefined when the site leaves it out, and it can be null. The post’s category. Manage the list (and each badge color) under Blog Categories. The related blog-category documents, in order (empty when none). To set it, send a list of { "_id": "…" }, one per document (one at most); a document the site can’t find is left out. At most 1 items.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).
Visibility | null
Sometimes sent: undefined when the site leaves it out, and it can be null. Select whether this content is public or private. One of public, loginRequired; a newer site may send others, so keep a fallback.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. Short teaser shown on the blog index and homepage. 1–2 sentences.
ImageArea
Sometimes sent: undefined when the site leaves it out. An ImageArea. Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area.
BlogMainArea
Sometimes sent: undefined when the site leaves it out. A BlogMainArea. Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area. A new document starts with @apostrophecms/rich-text.
AfterContentArea
Sometimes sent: undefined when the site leaves it out. An AfterContentArea. Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area.
readonly BlogPostFontOverridesItem[] | null
Sometimes sent: undefined when the site leaves it out, and it can be null. A list of BlogPostFontOverridesItem. Optional. Leave empty to follow the blog’s Reading settings (and, through them, the site fonts). Adding a row here replaces the blog-wide choice for this post only. At most 4 items.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. Overrides the document title in the browser tab and search results. Leave blank to use the regular title.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. Shown in search results and link previews. Aim for 150–160 characters.
ImageArea
Sometimes sent: undefined when the site leaves it out. An ImageArea. Used for Open Graph / social link previews. Recommended 1200×630. Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area. Its fields are listed under the first ImageArea above.
boolean | null
Sometimes sent: undefined when the site leaves it out, and it can be null. In the archive: kept, but out of every list and off the site until it is restored. false (or null) for a live document.
Date | null
Sometimes sent: undefined when the site leaves it out, and it can be null. When it was created (ISO 8601). Format: an ISO 8601 date and time.
Date | null
Sometimes sent: undefined when the site leaves it out, and it can be null. When it last changed (ISO 8601). Format: an ISO 8601 date and time.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. The document’s page on the site. Format: an absolute URL.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. The page that lists it (the blog page). Format: an absolute URL.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. That page’s slug.
Readonly<Record<string, unknown>>
Sometimes sent: undefined when the site leaves it out. That page, briefly (_id, title, slug, type, path, level).
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. The draft’s preview share key, while its share link is on: the link is the draft’s _url with aposShareKey and aposShareId (the draft’s _id) in its query. Absent otherwise, and on published documents.
Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below. Your exception handler turns them into your app’s own answers, once for every call (see Map SDK errors to responses); catch only what you want to react to here.
400
The site refused what was sent: errors lists each field’s problem, siteMessage the first.Retried first: No. Read: errors (field → messages), siteMessage.
401
The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.Retried first: No. Read: siteMessage, errorName, data.
403
The key may not do this: a scope it lacks, or an address outside its allowlist. siteMessage names it.Retried first: No. Read: siteMessage, errorName, data.
404
Nothing matches, or the caller may not see it.Retried first: No. Read: siteMessage, errorName, data.
500
The site failed. Its logs say why.Retried first: No: a write may have landed. Read: siteMessage, errorName, data.
no answer
No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Only when nothing reached the site (neverConnected()); never after a timeout, when it may have landed. Read: reason, neverConnected.
not sent
The client refused to send it (e.g. a path segment of ..); the site never saw it.Retried first: No. Read: reason (what to change).
any other
Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).Retried first: No. Read: reason, status.
setup
sites.forSite('acme') named a slug config/attract.ts doesn’t list (with the keys in the database: no row in attract_api_keys).Retried first: No: nothing was sent. Read: message, slug.
setup
The site’s entry is wrong: a malformed baseUrl or key, a key filed under another slug, or no default site. node ace attract:check names the fix.Retried first: No: nothing was sent. Read: message (what to fix).

Behavior

  • Access: an API key with content:blog:publish (or a master above it: content:blog:all, content:all, admin:all). A signed-in person may call it as far as their own permissions allow; anyone else gets 403.
  • Rate limit: the key’s own writes-per-minute limit, set when the key is created (default 120); over it, 429 with Retry-After. The client waits and retries for you; you see RateLimited only if that runs out.
  • Retries: a write is sent again only after a 429 (refused before it acted) or when it never reached the site. After a timeout or a 5xx it may have landed: check before you send it again.
  • Timeout: 15 s per attempt by default; raise timeout (milliseconds) in config/attract.ts for longer.

Test it

It calls the controller above with the SDK faked: fakeAttract() puts the fake in the container for this one test, and it answers every call with a valid example, so nothing leaves your machine and no key is read. Save it as tests/unit/blog_posts_publish_blog.spec.ts, then run your tests:
tests/unit/blog_posts_publish_blog.spec.ts
Terminal
Answer with your own values: fake blogPosts.publishBlog with factories.Blog({...}), the fields you give over a valid example.
tests/unit/blog_posts_publish_blog_answers.spec.ts

List a blog post’s locales

site.blogPosts().getBlogLocales()

Get the Markdown template

site.blogPosts().getBlogMarkdownTemplate()

Get the MDX template

site.blogPosts().getBlogMdxTemplate()

List blog posts

site.blogPosts().listBlogs()

Create a blog post

site.blogPosts().createBlog()

Get a blog post

site.blogPosts().getBlog()

POST /@apostrophecms/blog/{_id}/publish

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.