Skip to main content
POST
/
v1
/
api
/
ucf
/
dashboards
/
export
Export dashboards as an encrypted .ucf file
curl --request POST \
  --url 'https://api.upsolve.ai/v1/api/ucf/dashboards/export?apiKey=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "apiKey": "up_embed_************"
}
'
{
  "data": "<unknown>",
  "fileName": "<string>"
}

Authorizations

​
apiKey
string
query
required

apiKey MUST be supplied within the request body instead of query

Body

application/json

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

​
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/export Positive response

​
data
any
required
​
fileName
string
required