Is this deployment public, and how much does the current board open?

GET

/api/v1/settings/public-dashboard

curl --request GET \
  --url https://example.com/api/v1/settings/public-dashboard \
  --header 'Authorization: Bearer <token>'

Authorizations

• bearer

Responses

200

The switch state and the number of routes the current board opens

Media typeapplication/json

The state of the switch, and what it currently opens.

object

enabled

required

Whether anonymous visitors are served the public board.

boolean

route_count

required

How many API routes the current board opens to them.

Shown in the confirmation dialog before the switch is turned on — the cost stated before the click rather than discovered after it. Zero with an empty board, which is the honest answer: turning the switch on with nothing composed serves a page and no data.

integer

Example^generated

{
  "enabled": true,
  "route_count": 1
}

401

No valid bearer token

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Role lacks read permission

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}