Sign in

v1

latestOpenAPI 3.1.02026-07-263992128.7 KB
Assets

Create an asset

Create a data asset in the workspace linked to the API key.

Use this endpoint when an external system needs to register an asset for metadata, lineage, and observability workflows. The externalId must be unique for the workspace.

post/assets

Request body

assetNamestring required
externalIdstring required
integrationAccountIdstring required
integration'AIRBYTE_CLOUD' | 'AIRBYTE_SERVER' | 'AIRFLOW' | 'ARCH' | 'ALTERYX_SERVER' | 'AWS_EC2' | 'AWS_ECS' | 'AWS_EMR' | 'AWS_EKS' | 'AWS_FIREHOSE' | 'AWS_GLUE' | 'AWS_LAMBDA' | 'AWS_RDS' | 'AWS_REDSHIFT' | 'AWS_S3' | 'AWS_BEDROCK' | 'AWS_SAGEMAKER' | 'AWS_SECRETS_MANAGER' | 'AZURE' | 'AZURE_CONTAINER_APPS' | 'AZURE_DATA_FACTORY' | 'AZURE_DATA_LAKE_STORAGE' | 'AZURE_KEY_VAULT' | 'AZURE_KUBERNETES_SERVICE' | 'AZURE_LOGIC_APPS' | 'AZURE_SYNAPSE_ANALYTICS' | 'AZURE_VM' | 'BAUPLAN' | 'BOOMI' | 'CDATA' | 'CENSUS' | 'CLAUDE' | 'CLICKHOUSE' | 'COALESCE' | 'COUNT' | 'DATADOG' | 'DATABRICKS' | 'DATAPROC' | 'DATAZEN' | 'DBT' | 'DBT_CORE' | 'DLT' | 'DOMO' | 'DUCKDB' | 'EMAIL' | 'ESTUARY' | 'ETLEAP' | 'FABRIC' | 'FABRIC_SYNAPSE' | 'FIVETRAN' | 'FORTRA' | 'GCP_BIG_QUERY' | 'GCP_CLOUD_RUN' | 'GCP_CLOUD_FUNCTIONS' | 'GCP_CLOUD_STORAGE' | 'GCP_DATAFLOW' | 'GCP_DATAFORM' | 'GCP_DATASTREAM' | 'GCP_LOOKER' | 'GKE' | 'GITHUB_ACTIONS' | 'GOOGLE_CLOUD' | 'HEVO' | 'HEX' | 'HIGHTOUCH' | 'HTTP' | 'INFORMATICA_IICS' | 'INFORMATICA_POWERCENTER' | 'KAFKA' | 'KEBOOLA' | 'KLEENE' | 'LIGHTDASH' | 'LINUX_SSH' | 'MATILLION' | 'MATILLION_ETL' | 'METAPLANE' | 'MICROSOFT_TEAMS' | 'MICROSTRATEGY' | 'MOTHERDUCK' | 'NIMBLE' | 'OMNI' | 'OPEN_AI' | 'ORCHESTRA' | 'PARADIME' | 'PAGER_DUTY' | 'PINECONE' | 'PORTABLE' | 'POSTGRES' | 'POWER_AUTOMATE' | 'POWER_BI' | 'PREFECT_CLOUD' | 'PYTHON' | 'QLIK' | 'QLIK_REPLICATE' | 'RENDER' | 'RIVERY' | 'RUDDERSTACK' | 'SAP' | 'SFTP' | 'SIGMA' | 'SISENSE' | 'SLACK' | 'SNOWFLAKE' | 'SNOWPLOW' | 'SODA' | 'SQL_MESH' | 'SQL_SERVER' | 'STITCH' | 'STREAMKAP' | 'TABLEAU_CLOUD' | 'TALEND_CLOUD' | 'THOUGHTSPOT' | 'TOBIKO_CLOUD' | 'WEAVIATE' | 'WEBHOOK' | 'WELD' | 'WINDOWS_SSH' required
assetType'CHART' | 'DASHBOARD' | 'DASHBOARD_VIEWS' | 'DATASET' | 'QUERIES' | 'TABLE' | 'UNKNOWN' | 'VIEW' | 'WORKBOOK'
status'HEALTHY' | 'UNHEALTHY' | 'UNKNOWN' | 'WARNING'
createdInIntegrationstring date-time nullable
lastUpdatedInIntegrationstring date-time nullable
integrationAssetTypestring nullable
ownersstring[] nullable
metaobject nullable
databaseNamestring nullable
schemaNamestring nullable
tableNamestring nullable
descriptionstring nullable
workspaceNamestring nullable
workspaceIdstring nullable
urlstring nullable

Response

Resource created successfully.

assetIdstring uuid4 required
integration'AIRBYTE_CLOUD' | 'AIRBYTE_SERVER' | 'AIRFLOW' | 'ARCH' | 'ALTERYX_SERVER' | 'AWS_EC2' | 'AWS_ECS' | 'AWS_EMR' | 'AWS_EKS' | 'AWS_FIREHOSE' | 'AWS_GLUE' | 'AWS_LAMBDA' | 'AWS_RDS' | 'AWS_REDSHIFT' | 'AWS_S3' | 'AWS_BEDROCK' | 'AWS_SAGEMAKER' | 'AWS_SECRETS_MANAGER' | 'AZURE' | 'AZURE_CONTAINER_APPS' | 'AZURE_DATA_FACTORY' | 'AZURE_DATA_LAKE_STORAGE' | 'AZURE_KEY_VAULT' | 'AZURE_KUBERNETES_SERVICE' | 'AZURE_LOGIC_APPS' | 'AZURE_SYNAPSE_ANALYTICS' | 'AZURE_VM' | 'BAUPLAN' | 'BOOMI' | 'CDATA' | 'CENSUS' | 'CLAUDE' | 'CLICKHOUSE' | 'COALESCE' | 'COUNT' | 'DATADOG' | 'DATABRICKS' | 'DATAPROC' | 'DATAZEN' | 'DBT' | 'DBT_CORE' | 'DLT' | 'DOMO' | 'DUCKDB' | 'EMAIL' | 'ESTUARY' | 'ETLEAP' | 'FABRIC' | 'FABRIC_SYNAPSE' | 'FIVETRAN' | 'FORTRA' | 'GCP_BIG_QUERY' | 'GCP_CLOUD_RUN' | 'GCP_CLOUD_FUNCTIONS' | 'GCP_CLOUD_STORAGE' | 'GCP_DATAFLOW' | 'GCP_DATAFORM' | 'GCP_DATASTREAM' | 'GCP_LOOKER' | 'GKE' | 'GITHUB_ACTIONS' | 'GOOGLE_CLOUD' | 'HEVO' | 'HEX' | 'HIGHTOUCH' | 'HTTP' | 'INFORMATICA_IICS' | 'INFORMATICA_POWERCENTER' | 'KAFKA' | 'KEBOOLA' | 'KLEENE' | 'LIGHTDASH' | 'LINUX_SSH' | 'MATILLION' | 'MATILLION_ETL' | 'METAPLANE' | 'MICROSOFT_TEAMS' | 'MICROSTRATEGY' | 'MOTHERDUCK' | 'NIMBLE' | 'OMNI' | 'OPEN_AI' | 'ORCHESTRA' | 'PARADIME' | 'PAGER_DUTY' | 'PINECONE' | 'PORTABLE' | 'POSTGRES' | 'POWER_AUTOMATE' | 'POWER_BI' | 'PREFECT_CLOUD' | 'PYTHON' | 'QLIK' | 'QLIK_REPLICATE' | 'RENDER' | 'RIVERY' | 'RUDDERSTACK' | 'SAP' | 'SFTP' | 'SIGMA' | 'SISENSE' | 'SLACK' | 'SNOWFLAKE' | 'SNOWPLOW' | 'SODA' | 'SQL_MESH' | 'SQL_SERVER' | 'STITCH' | 'STREAMKAP' | 'TABLEAU_CLOUD' | 'TALEND_CLOUD' | 'THOUGHTSPOT' | 'TOBIKO_CLOUD' | 'WEAVIATE' | 'WEBHOOK' | 'WELD' | 'WINDOWS_SSH' required
accountIdstring uuid4 required
assetNamestring required
assetType'CHART' | 'DASHBOARD' | 'DASHBOARD_VIEWS' | 'DATASET' | 'QUERIES' | 'TABLE' | 'UNKNOWN' | 'VIEW' | 'WORKBOOK' required
integrationAccountIdstring required
databaseNamestring nullable
schemaNamestring nullable
workspaceNamestring nullable
workspaceIdstring nullable
externalIdstring required
connectionstring nullable
status'HEALTHY' | 'UNHEALTHY' | 'UNKNOWN' | 'WARNING' required
createdAtstring required
updatedAtstring required
connectionIntegration'AIRBYTE_CLOUD' | 'AIRBYTE_SERVER' | 'AIRFLOW' | 'ARCH' | 'ALTERYX_SERVER' | 'AWS_EC2' | 'AWS_ECS' | 'AWS_EMR' | 'AWS_EKS' | 'AWS_FIREHOSE' | 'AWS_GLUE' | 'AWS_LAMBDA' | 'AWS_RDS' | 'AWS_REDSHIFT' | 'AWS_S3' | 'AWS_BEDROCK' | 'AWS_SAGEMAKER' | 'AWS_SECRETS_MANAGER' | 'AZURE' | 'AZURE_CONTAINER_APPS' | 'AZURE_DATA_FACTORY' | 'AZURE_DATA_LAKE_STORAGE' | 'AZURE_KEY_VAULT' | 'AZURE_KUBERNETES_SERVICE' | 'AZURE_LOGIC_APPS' | 'AZURE_SYNAPSE_ANALYTICS' | 'AZURE_VM' | 'BAUPLAN' | 'BOOMI' | 'CDATA' | 'CENSUS' | 'CLAUDE' | 'CLICKHOUSE' | 'COALESCE' | 'COUNT' | 'DATADOG' | 'DATABRICKS' | 'DATAPROC' | 'DATAZEN' | 'DBT' | 'DBT_CORE' | 'DLT' | 'DOMO' | 'DUCKDB' | 'EMAIL' | 'ESTUARY' | 'ETLEAP' | 'FABRIC' | 'FABRIC_SYNAPSE' | 'FIVETRAN' | 'FORTRA' | 'GCP_BIG_QUERY' | 'GCP_CLOUD_RUN' | 'GCP_CLOUD_FUNCTIONS' | 'GCP_CLOUD_STORAGE' | 'GCP_DATAFLOW' | 'GCP_DATAFORM' | 'GCP_DATASTREAM' | 'GCP_LOOKER' | 'GKE' | 'GITHUB_ACTIONS' | 'GOOGLE_CLOUD' | 'HEVO' | 'HEX' | 'HIGHTOUCH' | 'HTTP' | 'INFORMATICA_IICS' | 'INFORMATICA_POWERCENTER' | 'KAFKA' | 'KEBOOLA' | 'KLEENE' | 'LIGHTDASH' | 'LINUX_SSH' | 'MATILLION' | 'MATILLION_ETL' | 'METAPLANE' | 'MICROSOFT_TEAMS' | 'MICROSTRATEGY' | 'MOTHERDUCK' | 'NIMBLE' | 'OMNI' | 'OPEN_AI' | 'ORCHESTRA' | 'PARADIME' | 'PAGER_DUTY' | 'PINECONE' | 'PORTABLE' | 'POSTGRES' | 'POWER_AUTOMATE' | 'POWER_BI' | 'PREFECT_CLOUD' | 'PYTHON' | 'QLIK' | 'QLIK_REPLICATE' | 'RENDER' | 'RIVERY' | 'RUDDERSTACK' | 'SAP' | 'SFTP' | 'SIGMA' | 'SISENSE' | 'SLACK' | 'SNOWFLAKE' | 'SNOWPLOW' | 'SODA' | 'SQL_MESH' | 'SQL_SERVER' | 'STITCH' | 'STREAMKAP' | 'TABLEAU_CLOUD' | 'TALEND_CLOUD' | 'THOUGHTSPOT' | 'TOBIKO_CLOUD' | 'WEAVIATE' | 'WEBHOOK' | 'WELD' | 'WINDOWS_SSH'
lastSuccessfulRunstring nullable
upstreamDependenciesstring[] nullable
downstreamDependenciesstring[] nullable
integrationAssetTypestring nullable
ownerstring nullable
ownersstring[] nullable
createdInIntegrationstring nullable
lastUpdatedInIntegrationstring nullable
usagePercentagenumber nullable
freshnessConfigobject nullable
metaobject nullable
tableNamestring nullable
rowCountinteger nullable
bytesinteger nullable
descriptionstring nullable
urlstring nullable
lastViewedstring nullable
uniqueViewersinteger nullable
viewCountinteger nullable
viewCountFromTimestampstring nullable