Appearance
System API
Administrators. Version and one-click updates (signed releases from REPLORA_UPDATE_FEED).
All paths are relative to https://your-site.com/api/v1. Send Authorization: Bearer <token> and Accept: application/json; see authentication and errors.
GET /branding
The installation's logo and favicon, light and dark mode (administrators)
Public addresses of the uploaded pictures (null = the built-in mark; a missing dark version means the light one is used in dark mode too). Also in the dashboard's boot data.
Responses
- 200 — OK
- 403 — Not allowed (not an administrator, or outside the token's abilities).
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.logo | string, nullable | Logo for light backgrounds. | |
data.logo_dark | string, nullable | Logo for dark backgrounds (the sidebar, dark mode). | |
data.favicon | string, nullable | ||
data.favicon_dark | string, nullable | Favicon when the browser is in dark mode. |
bash
curl -X GET "https://your-site.com/api/v1/branding" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /branding/{kind}
Uploads a logo or favicon (administrators)
PNG, JPEG or WebP up to 2 MB (never SVG). The server re-encodes it as PNG; logos are scaled to at most 320 px high, favicons made 192 × 192 px. Replaces the previous picture of that kind.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
kind | path | string | yes | One of: logo, logo_dark, favicon, favicon_dark. |
Request body
multipart/form-data, required
| Field | Type | Required | Description |
|---|---|---|---|
file | string (binary) | yes |
Responses
- 200 — The pictures now.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.logo | string, nullable | Logo for light backgrounds. | |
data.logo_dark | string, nullable | Logo for dark backgrounds (the sidebar, dark mode). | |
data.favicon | string, nullable | ||
data.favicon_dark | string, nullable | Favicon when the browser is in dark mode. |
bash
curl -X POST "https://your-site.com/api/v1/branding/{kind}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-F "file=…"DELETE /branding/{kind}
Removes a logo or favicon (administrators)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
kind | path | string | yes | One of: logo, logo_dark, favicon, favicon_dark. |
Responses
- 200 — The pictures now.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.logo | string, nullable | Logo for light backgrounds. | |
data.logo_dark | string, nullable | Logo for dark backgrounds (the sidebar, dark mode). | |
data.favicon | string, nullable | ||
data.favicon_dark | string, nullable | Favicon when the browser is in dark mode. |
bash
curl -X DELETE "https://your-site.com/api/v1/branding/{kind}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /system
Version, edition, the remembered latest release and what one-click updates need (administrators)
Responses
- 200 — The installation's state.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.version | string | Version of the files. | |
data.data_version | string, nullable | Version the database belongs to. | |
data.edition | string | One of: single, saas. | |
data.php | string | ||
data.pending | boolean | An update waits to be finished (POST /system/upgrade). | |
data.downgrade | boolean | The files are older than the data. | |
data.feed | boolean | A release feed is configured. | |
data.release | object, nullable | ||
data.release.version | string | ||
data.release.released_at | string, nullable | ||
data.release.notes | string | ||
data.update_available | boolean | ||
data.one_click | object | ||
data.one_click.possible | boolean | ||
data.one_click.problem | string, nullable | ||
data.backups | integer |
bash
curl -X GET "https://your-site.com/api/v1/system" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /system/health
The service status: the last run of every check (run now when there is none yet), and maintenance mode (administrators)
Responses
- 200 — Checks with their status (ok, warn, fail, off) and a sentence each; maintenance mode.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.checked_at | string (date-time) | ||
data.status | string | The worst of the checks. One of: ok, warn, fail, off. | |
data.checks | object[] | ||
data.checks[].id | string | ||
data.checks[].label | string | ||
data.checks[].status | string | One of: ok, warn, fail, off. | |
data.checks[].detail | string | ||
data.checks[].ms | integer | How long the check took. | |
data.maintenance | object | ||
data.maintenance.on | boolean | ||
data.maintenance.since | string (date-time), nullable | ||
data.maintenance.message | string, nullable |
bash
curl -X GET "https://your-site.com/api/v1/system/health" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /system/health
Runs every service check now (10 per minute)
Responses
- 200 — The fresh checks.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.checked_at | string (date-time) | ||
data.status | string | The worst of the checks. One of: ok, warn, fail, off. | |
data.checks | object[] | ||
data.checks[].id | string | ||
data.checks[].label | string | ||
data.checks[].status | string | One of: ok, warn, fail, off. | |
data.checks[].detail | string | ||
data.checks[].ms | integer | How long the check took. | |
data.maintenance | object | ||
data.maintenance.on | boolean | ||
data.maintenance.since | string (date-time), nullable | ||
data.maintenance.message | string, nullable |
bash
curl -X POST "https://your-site.com/api/v1/system/health" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"PUT /system/maintenance
Turns maintenance mode on (with an optional message) or off. Administrators keep using the dashboard and can sign in; recording, surveys, A/B tests and webhooks keep working.
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
on | boolean | yes | |
message | string, nullable | Shown on the maintenance page. At most 500 characters. |
Responses
- 200 — The new state;
bypassis Laravel's bypass path when turned on. - 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 —
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.on | boolean | ||
data.since | string (date-time), nullable | ||
data.message | string, nullable | ||
data.bypass | string, nullable |
bash
curl -X PUT "https://your-site.com/api/v1/system/maintenance" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"on":true,"message":"text"}'GET /system/license
The purchase code this site runs with (shortened), its plan and support end, and the modules it brings (missing or from another version).
Responses
- 200 — The license state.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.code | string, nullable | The saved purchase code shortened, e.g. 1a2b…5e6f; null when none is saved. | |
data.plan | string, nullable | single or saas | |
data.verified_at | string (date-time), nullable | ||
data.checked_at | string (date-time), nullable | ||
data.supported_until | string (date-time), nullable | ||
data.required | boolean | False for builds that bundle every module and may run without a code. | |
data.modules | object | ||
data.modules.missing | string[] | ||
data.modules.outdated | string[] |
bash
curl -X GET "https://your-site.com/api/v1/system/license" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"PUT /system/license
Checks a purchase code with the license server for this site's address and saves it; missing or older modules are downloaded (signed pack). The SaaS edition accepts only SaaS codes. 6 per minute.
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
purchase_code | string | yes | At most 200 characters. |
Responses
- 200 — The new state;
restartwhen modules were just installed (reload the dashboard to run them). - 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 —
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.code | string, nullable | The saved purchase code shortened, e.g. 1a2b…5e6f; null when none is saved. | |
data.plan | string, nullable | single or saas | |
data.verified_at | string (date-time), nullable | ||
data.checked_at | string (date-time), nullable | ||
data.supported_until | string (date-time), nullable | ||
data.required | boolean | False for builds that bundle every module and may run without a code. | |
data.modules | object | ||
data.modules.missing | string[] | ||
data.modules.outdated | string[] | ||
data.restart | boolean |
bash
curl -X PUT "https://your-site.com/api/v1/system/license" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"purchase_code":"text"}'POST /system/check
Asks the release feed now (6 per minute)
Responses
- 200 — The state with the latest release.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 502 — The release feed could not be read;
messagesays why.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.version | string | Version of the files. | |
data.data_version | string, nullable | Version the database belongs to. | |
data.edition | string | One of: single, saas. | |
data.php | string | ||
data.pending | boolean | An update waits to be finished (POST /system/upgrade). | |
data.downgrade | boolean | The files are older than the data. | |
data.feed | boolean | A release feed is configured. | |
data.release | object, nullable | ||
data.release.version | string | ||
data.release.released_at | string, nullable | ||
data.release.notes | string | ||
data.update_available | boolean | ||
data.one_click | object | ||
data.one_click.possible | boolean | ||
data.one_click.problem | string, nullable | ||
data.backups | integer |
bash
curl -X POST "https://your-site.com/api/v1/system/check" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /system/update
Installs the latest release's files (signature checked, current files backed up)
The data side is finished by POST /system/upgrade in the next request (restart is true), so the new code runs it.
Responses
- 200 — The files are in place.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 — Up to date, or the release can't be installed here;
messagesays why. Nothing was changed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.from | string | ||
data.to | string | ||
data.restart | boolean |
bash
curl -X POST "https://your-site.com/api/v1/system/update" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /system/upgrade
Finishes an update (missing modules from the license server, migrations, upgrade steps, caches) and answers what ran
Responses
- 200 — Done; or only
restart: truewhen the new version's modules were just installed: call again, the next request runs them and finishes. - 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 — A downgrade, another update running, modules that can't be fetched (no or refused purchase code), or a failing migration or step;
messagesays which.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.from | string, nullable | ||
data.to | string | ||
data.migrations | string[] | ||
data.steps | string[] | ||
data.restart | boolean |
bash
curl -X POST "https://your-site.com/api/v1/system/upgrade" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /system/rollback
Puts the previous version's files back (database changes stay)
Responses
- 200 — The previous files are back.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 — There is no backup.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.version | string | ||
data.restart | boolean |
bash
curl -X POST "https://your-site.com/api/v1/system/rollback" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"