Skip to main content
POST
Start a connection metadata job

Authorizations

authorization
string
header
required

Body

application/json

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

connectionId
string
required

The ID of the connection to compute metadata for

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
organizationId
string

The ID of the organization. Required when using Supabase JWT authentication.

projectId
string
mode
enum<string>
default:v2
Available options:
v1,
v2
catalogNames
string[]
schemaNames
string[]
keepQueries
boolean
refreshConnectionSchema
boolean
dataModelId
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})$
dataModelVersion
integer
Required range: 0 <= x <= 9007199254740991

Response

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

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