Skip to main content
POST
/
v1
/
api
/
connection
/
compute-metadata
curl --request POST \
  --url https://api.upsolve.ai/v1/api/connection/compute-metadata \
  --header 'Content-Type: application/json' \
  --data '{
  "apiKey": "up_embed_************",
  "connectionId": "550e8400-e29b-41d4-a716-446655440000"
}'
{
  "status": "success",
  "data": {
    "metadata": {
      "public.users": {
        "tableName": "users",
        "schemaName": "public",
        "columns": [
          {
            "columnName": "id",
            "dataType": "integer",
            "isPrimaryKey": true,
            "selectable": false
          },
          {
            "columnName": "email",
            "dataType": "varchar",
            "selectable": true
          },
          {
            "columnName": "created_at",
            "dataType": "timestamp",
            "selectable": false
          }
        ]
      }
    }
  }
}

Authorizations

​
apiKey
string
query
required

apiKey MUST be supplied within the request body instead of query

Body

application/json

POST /v1/api/connection/compute-metadata Request body

​
apiKey
string
required

Upsolve API key, generated in the Deploy tab of the Upsolve Hub.

Minimum length: 1
Examples:

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

​
connectionId
string<uuid>
required

The ID of the connection to compute metadata for

Examples:

"550e8400-e29b-41d4-a716-446655440000"

​
organizationId
string

[Optional] The ID of the org the API key is being used with. Only needed if the API key is being used for an organization other than the org that generated it.

Examples:

"do-not-use"

​
user
string

The ID of the user making the request (optional)

​
projectId
string

Project ID (optional, required for Data plane connections)

​
catalogNames
string[]

Array of catalog names to compute metadata for (optional, for Data plane connections)

​
schemaNames
string[]

Array of schema names to compute metadata for (optional)

​
keepQueries
boolean

Whether to keep queries for debugging (optional)

Response

POST /v1/api/connection/compute-metadata Positive response

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