Routes
| Route | Does |
|---|---|
POST {Path}/command |
runs a command, { type, payload, runId? }, and answers its result as JSON |
GET {Path}/stream |
the event stream (server-sent events) |
POST {Path}/upload?id=&property=&name=&context= |
stores the request body in a file property and answers the file |
POST {Path}/auth/login |
a token for { userName, password }, checked by VerifyLogin |
POST {Path}/auth/session |
a token for the user the site's own sign-in cookie names |
POST {Path}/auth/refresh |
a new token for a valid one |
GET {Path}/skin-logos/{logo} |
a skin's logo, without a token, for the login screen |
GET {Path}/modules/{name}/{version}/… |
a module's interface plugin (chapter 18) |
Path is /relatude.cms/api unless CmsApiOptions.Path says otherwise. A failure answers
{ error } with a status:
| Status | When |
|---|---|
| 400 | the payload, a value or the query cannot be used |
| 401 | no valid token |
| 403 | Authorize refused, or the command is for administrators |
| 404 | the node does not exist, or the user cannot read it |
| 409 | the command conflicts with the node's state, such as a second published revision in a culture |
| 499 | the command was stopped |
| 503 | the database is not open yet |
| 500 | anything else |
To stop a command, send it with a runId of your choice, then send command-cancel with that
{ runId }.