Batch jobs

Publish blog posts

Publishes each listed draft, as a background job. Answers at once with the job’s id. Every id must name a document the caller may edit, or no job starts: 404 names the ids that matched nothing.

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.

POST

@apostrophecms

blog

publish

cURL

curl --request POST \
  --url https://{host}/api/v1/@apostrophecms/blog/publish \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "_ids": [
    "<string>"
  ]
}
'

{
  "jobId": "<string>"
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

Authorizations

Authorization

string

header

required

Paste your API key as the CMS showed it: fsk_<site>_<key id>_<secret> (issued under API Keys). ApiKey in front of it works too. Leave it empty to read as the public.

Scopes

content:blog:publish

Body

application/json

Documents to act on, by _id.

_ids

string[]

required

The documents’ _ids: a full id names its own locale and mode (a draft’s …:en:draft, a published …:en:published; no aposMode needed), a bare aposDocId takes the request’s (aposLocale, aposMode).

messages

object

The notification texts the CMS shows signed-in users while the job runs ({{ type }} and {{ count }} are filled in). Optional.

Show child attributes

Response

The job started.

A background job started: the work runs after this answer, so it says the job began, not that it finished. Each document is checked against the caller’s permissions as the job reaches it; one it may not touch is skipped, not an error. The management API follows a job (GET /@apostrophecms/job/{jobId}: its progress, what failed, when it ended); an API key can’t yet, so read the documents themselves to see the result.

jobId

string

required

The job’s id, for the management API’s job routes (read it, cancel it).

cURL

curl --request POST \
  --url https://{host}/api/v1/@apostrophecms/blog/publish \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "_ids": [
    "<string>"
  ]
}
'

{
  "jobId": "<string>"
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

Get started

How the API works

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

Signing in (people)

Publish blog posts

Authorizations

Scopes

Body

Response