Sign in

v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
App Builder

Create App

Create a new app, returning the app ID. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

post/api/v2/app-builder/apps

Request body

Example request

{
  "data": {
    "attributes": {
      "components": [
        {
          "events": [],
          "name": "grid0",
          "properties": {
            "children": [
              {
                "events": [],
                "name": "gridCell0",
                "properties": {
                  "children": [
                    {
                      "events": [],
                      "name": "calloutValue0",
                      "properties": {
                        "isDisabled": false,
                        "isLoading": false,
                        "isVisible": true,
                        "label": "CPU Usage",
                        "size": "sm",
                        "style": "vivid_yellow",
                        "unit": "kB",
                        "value": "42"
                      },
                      "type": "calloutValue"
                    }
                  ],
                  "isVisible": "true",
                  "layout": {
                    "default": {
                      "height": 8,
                      "width": 2,
                      "x": 0,
                      "y": 0
                    }
                  }
                },
                "type": "gridCell"
              }
            ]
          },
          "type": "grid"
        }
      ],
      "description": "This is a simple example app",
      "name": "Example App",
      "queries": [],
      "rootInstanceName": "grid0"
    },
    "type": "appDefinitions"
  }
}

Response

Created

Example response

{
  "data": {
    "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
    "type": "appDefinitions"
  }
}