/api/setup
Perform a first time setup of Zipline, or retrieve the current setup status. This endpoint is used internally during the first run of Zipline to initialize a user.
Info
This route will always return a 403 Forbidden status if the setup is already
complete.
GET Request
Response
Status: 200 OK
Content-Type: application/json
| Property | Type | Description |
|---|---|---|
firstSetup | boolean | true if the app is not set up and first user must be created. |
Error Responses
-
403 Forbidden
Setup has already been completed.
POST Request
Body
Content-Type: application/json
| Property | Type | Description |
|---|---|---|
username | string | Username to create. |
password | string | Password to set. |
Example
{"username": "admin","password": "zipline"}
Response
Status: 200 OK
Content-Type: application/json
| Property | Type | Description |
|---|---|---|
firstSetup | boolean | Always true (setup was running). |
user | User | The newly created user object. |
Example
{"firstSetup": true,"user": {"id": "cmb6042f500029kenox2u8npu","username": "admin","createdAt": "2025-05-27T04:13:22.625Z","updatedAt": "2025-05-27T04:13:22.625Z","role": "SUPERADMIN","view": {},"oauthProviders": [],"totpSecret": null,"passkeys": [],"quota": null,"sessions": []}}
Error Responses
-
400 Bad Request
If the request body is invalid or missing required fields.
-
403 Forbidden
If the setup has already been completed.
/api/healthcheck
Perform a simple healthcheck on the database and backend of Zipline. R...
/api/stats
Get metrics and statistics of the current Zipline instance.
Last updated: 5/28/2025
Edit this page on GitHub