Skip to main content
POST
/
v1
/
api
/
ucf
/
dashboards
/
import
Import a dashboard .ucf file as an upsert
curl --request POST \
  --url 'https://api.upsolve.ai/v1/api/ucf/dashboards/import?apiKey=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "apiKey": "up_embed_************"
}
'
{
  "status": "<string>",
  "data": {
    "organizationId": "<string>",
    "generatedAt": "<string>",
    "tables": {
      "charts": {
        "received": 4503599627370495,
        "processed": 4503599627370495
      },
      "charts_versioning": {
        "received": 4503599627370495,
        "processed": 4503599627370495
      },
      "dashboards": {
        "received": 4503599627370495,
        "processed": 4503599627370495
      },
      "dashboards_versioning": {
        "received": 4503599627370495,
        "processed": 4503599627370495
      },
      "chart_filters": {
        "received": 4503599627370495,
        "processed": 4503599627370495
      },
      "dashboard_filters": {
        "received": 4503599627370495,
        "processed": 4503599627370495
      },
      "dashboard_themes": {
        "received": 4503599627370495,
        "processed": 4503599627370495
      }
    }
  }
}

Authorizations

​
apiKey
string
query
required

apiKey MUST be supplied within the request body instead of query

Body

application/json

POST /v1/api/ucf/dashboards/import Request body

​
data
string
required

The encrypted .ucf payload produced by the export endpoint (hex IV:hex ciphertext)

Minimum string length: 1
​
apiKey
string

Upsolve API key, generated under Account → Developer settings in the Upsolve Hub. Keys are user-scoped: pass organizationId alongside the key to select which org to act on.

Minimum string length: 1
Example:

"up_embed_************"

​
organizationId
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Response

POST /v1/api/ucf/dashboards/import Positive response

​
status
string
required
Allowed value: "success"
​
data
object
required