Skip to content
Aura

Restart Dashboard

POST
/api/v1/projects/{project_id}/run/dashboard/restart
curl --request POST \
  --url https://aura-api-eu.strangeworks.com/api/v1/projects/example/run/dashboard/restart \
  --header 'Authorization: Bearer <token>'

Kill the project’s dashboard process and start a fresh one.

Real credentials, never a view ticket: a viewer of the dashboard must not be able to restart it. Unconditional and non-blocking — every call restarts, and it returns as soon as the old process is gone rather than waiting for the new one to serve. Reach for it when the entrypoint or the dependencies changed under a running process, or when one has wedged.

restart broadcasts dashboard_restarted, which sets the rebuilding wait for every viewer; only a terminal signal clears it. Since this returns before the process serves, it schedules the same off-viewer wait the checkout does — dashboard_serving on success, dashboard_rebuild_failed on a terminal outcome — so a viewer off the dashboard is not stranded rebuilding.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
project_id
required
Project Id
string

Responses

Section titled “Responses”

202

Section titled “202”

Successful Response

Media typeapplication/json
DashboardRestartResponse

The state a restart left behind.

Never ready: the restart returns once the old process is gone, not once the new one is serving, so the caller’s next request lands on the holding page and refreshes itself from there.

object
detail
required
Detail
string
port
required
Any of:
integer
state
required
State
string
Examplegenerated
{
  "detail": "example",
  "port": 1,
  "state": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}