Login to get authentication token

POST

@apostrophecms

curl --request POST \
  --url https://{host}/api/v1/@apostrophecms/login/login \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "admin",
  "password": "your-password"
}
'

{
  "token": "random123Token456xyz"
}

Body

application/json

username

string

required

User's login username

Example:

"admin"

password

string<password>

required

User's password

session

boolean

default:false

Set to true to receive session cookie instead of bearer token

Example:

false

Response

token

string

Bearer token (only present when session is false/omitted)

Example:

"random123Token456xyz"

curl --request POST \
  --url https://{host}/api/v1/@apostrophecms/login/login \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "admin",
  "password": "your-password"
}
'

{
  "token": "random123Token456xyz"
}

Get started

How the API works

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

Signing in (people)

Body

Response