Skip to main content
POST
Deploy model

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

model_id
string<uuid>
required

Body

application/json

Request to deploy an approved model.

create_schedule
boolean
default:false

Create an Airflow DAG for scheduled refresh.

schedule_cron
string | null

Cron schedule. Required if create_schedule=True.

register_in_datahub
boolean
default:true

Register the deployed view in DataHub.

add_lineage
boolean
default:true

Add lineage from source tables.

create_dashboard
boolean
default:true

Create a Superset dashboard for the deployed model.

Response

Model deployed.

Response for model deployment.

model_id
string<uuid>
required
view_name
string
required
status
enum<string>
required

Status of a semantic model.

Available options:
draft,
pending_review,
approved,
rejected,
deployed,
failed,
archived
deployed_at
string<date-time>
required
message
string
required
external_id
string | null

DataHub URN if registered.

job_id
string<uuid> | null

Airflow job ID if scheduled.

airflow_url
string | null

Airflow DAG URL.

dashboard
DashboardInfo · object | null

Superset dashboard info if created.