ApostropheCMS REST API

REST discovered

Details

URL: https://<your-apostrophe-site>/api/v1
Spec: https://raw.githubusercontent.com/apostrophecms/apostrophecms-openapi/main/apostrophecms-openapi.yaml
Docs: https://apostrophecms.com/docs/reference/api/rest-api-reference.html

Authentication

ApostropheCMS API key api_key discovered Get key ↗

In your own ApostropheCMS project, configure an API key in modules/@apostrophecms/express/index.js under the apiKeys option. The docs show an example like apiKeys: { myTestKey: { role: 'admin' } }. See Authentication and API Explorer. This is project-defined rather than minted from a hosted developer console.

ApostropheCMS bearer token bearer discovered Get token ↗

Use an existing ApostropheCMS user account in your own project and create a token by calling the login route POST /api/v1/@apostrophecms/login/login with username and password. The response includes a token that is then sent as Authorization: Bearer <token>. See Login module reference, Authentication, and the headless CMS guide.