Dashboards

Create a dashboard

POST/dashboards
dashboards:writecreate_dashboard

Creates the dashboard for a type and user type and returns it with a Location. type and definition are required; leave user_type out for the default dashboard that serves every user type without its own. definition is an object of up to 256 KiB once encoded. A live dashboard with the same type and user type returns 409 conflict. dry_run shows the result without saving it. Emits dashboard.created; no email. DELETE /dashboards/{id} undoes it.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, required · DashboardCreate

  • typestringRequired#

    Which page the dashboard lays out: HOMEPAGE is the platform home page, INVESTOR_DASHBOARD is the investor's dashboard.

    One of: HOMEPAGE, INVESTOR_DASHBOARD
  • user_typestring | null#

    The kind of user the dashboard is for: User (investor), Internal User, Entrepreneur or Advisor. Omit or send null for the default dashboard. One live dashboard may hold each type and user type.

    One of: User, Internal User, Entrepreneur, Advisor
  • definitionobjectRequired#

    The page layout, a JSON object of up to 256 KiB once encoded.

{
  "type": "HOMEPAGE",
  "user_type": "User",
  "definition": {
    "content": [
      {
        "type": "Heading",
        "props": {
          "id": "Heading-1",
          "text": "Welcome"
        }
      }
    ],
    "root": {
      "props": {
        "title": "Home"
      }
    }
  }
}

Responses

201

The dashboard was created.

Dashboard
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "type": "HOMEPAGE",
    "user_type": "User",
    "definition": {},
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
409

The request conflicts with existing state (error.code = conflict), e.g. a compliance flow with the requested name already exists.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/dashboards\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "type": "HOMEPAGE",
  "user_type": "User",
  "definition": {
    "content": [
      {
        "type": "Heading",
        "props": {
          "id": "Heading-1",
          "text": "Welcome"
        }
      }
    ],
    "root": {
      "props": {
        "title": "Home"
      }
    }
  }
}'