Pages

Delete a page

Deletes the page for good, in the mode asked (it is not moved to the archive). Unpublish a published page first, then delete its draft. The home page and a page with children can’t be deleted.

Access: an API key with content:pages:delete (or a master above it: content:pages: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.

DELETE

@apostrophecms

page

{_id}

cURL

curl --request DELETE \
  --url https://{host}/api/v1/@apostrophecms/page/{_id} \
  --header 'Authorization: <api-key>'

{
  "name": "invalid",
  "data": {},
  "message": "You must delete the children of this page first."
}

{
  "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:pages:delete

Path Parameters

_id

string

required

Computed document ID (can optionally include mode and locale, e.g., id:en:published)

Pattern: ^\S+$

Example:

"ckitdo5oq004pu69kr6oxo6fr:en:published"

Query Parameters

aposMode

enum<string>

default:published

published (the default) or draft. Drafts need a credential that may see them: an API key with the type’s write scope (content:<type>:write), or a signed-in editor. The public and a key with only the read scope get 403.

Available options:

draft,

published

aposLocale

string

The locale to read or write, e.g. en (default: the site’s default locale).

Example:

"fr"

Response

Deleted, for good (not moved to the archive). No body.

cURL

curl --request DELETE \
  --url https://{host}/api/v1/@apostrophecms/page/{_id} \
  --header 'Authorization: <api-key>'

{
  "name": "invalid",
  "data": {},
  "message": "You must delete the children of this page first."
}

{
  "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)

Delete a page

Authorizations

Scopes

Path Parameters

Query Parameters

Response