GEgetorchestra
Assets

Create an asset

Changed on

Create a data asset in the workspace the credential resolves to.

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

  • Base URL
    https://app.getorchestra.io/api/engine/public
  • URL
    https://app.getorchestra.io/api/engine/public/assets
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getorchestra.io/oauth/authorize
      Token URL: https://app.getorchestra.io/oauth/token scopes: orchestra:write

Headers

X-Orchestra-Account-Idstring uuid4 nullable

Act on this account rather than the one the credential resolves to. Omit it to use the credential's own account. An API key is issued to a single account, so it may only name that account; an OAuth token may name any account its grant covers.

Request body

assetNamestring required
externalIdstring required
integrationAccountIdstring required
integration'AIRBYTE_CLOUD' | 'AIRBYTE_SERVER' | 'AIRFLOW' | 'ARCH' | 'ALTERYX_SERVER' | 'ANTHROPIC' | 'AWS_EC2' | 'AWS_ECS' | 'AWS_EMR' | 'AWS_EKS' | 'AWS_FIREHOSE' | 'AWS_GLUE' | 'AWS_LAMBDA' | 'AWS_RDS' | 'AWS_REDSHIFT' | 'AWS_S3' | 'AWS_BATCH' | 'AWS_BEDROCK' | 'AWS_SAGEMAKER' | 'AWS_SECRETS_MANAGER' | 'AWS_SES' | 'AWS_STEP_FUNCTIONS' | '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' | 'CLICKHOUSE' | 'COALESCE' | 'COUNT' | 'DATADOG' | 'DATABRICKS' | 'DATAPROC' | 'DATAZEN' | 'DBT' | 'DBT_CORE' | 'DLT' | 'DOMO' | 'DREMIO' | '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' | 'HUBSPOT' | 'INFORMATICA_IICS' | 'INFORMATICA_POWERCENTER' | 'KAFKA' | 'KEBOOLA' | 'KLEENE' | 'LIGHTDASH' | 'LINUX_SSH' | 'MARIADB' | 'MATILLION' | 'MATILLION_ETL' | 'METAPLANE' | 'MICROSOFT_TEAMS' | 'MICROSTRATEGY' | 'MONGODB' | 'MOTHERDUCK' | 'MYSQL' | 'N8N' | 'NIMBLE' | 'NOTION' | 'OMNI' | 'OPEN_AI' | 'ORCHESTRA' | 'PARADIME' | 'PAGER_DUTY' | 'PINECONE' | 'PORTABLE' | 'POSTGRES' | 'POWER_AUTOMATE' | 'POWER_BI' | 'PREFECT_CLOUD' | 'PYTHON' | 'QLIK' | 'QLIK_REPLICATE' | 'QUICKBOOKS' | 'RENDER' | 'RIVERY' | 'RUDDERSTACK' | 'SALESFORCE' | 'SAP' | 'SFTP' | 'SHAREPOINT' | 'SIGMA' | 'SISENSE' | 'SLACK' | 'SNOWFLAKE' | 'SNOWPLOW' | 'SODA' | 'SQL_MESH' | 'SQL_SERVER' | 'STITCH' | 'STREAMKAP' | 'TABLEAU_CLOUD' | 'TALEND_CLOUD' | 'THOUGHTSPOT' | 'TOBIKO_CLOUD' | 'TYPESAFE' | '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' | 'ANTHROPIC' | 'AWS_EC2' | 'AWS_ECS' | 'AWS_EMR' | 'AWS_EKS' | 'AWS_FIREHOSE' | 'AWS_GLUE' | 'AWS_LAMBDA' | 'AWS_RDS' | 'AWS_REDSHIFT' | 'AWS_S3' | 'AWS_BATCH' | 'AWS_BEDROCK' | 'AWS_SAGEMAKER' | 'AWS_SECRETS_MANAGER' | 'AWS_SES' | 'AWS_STEP_FUNCTIONS' | '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' | 'CLICKHOUSE' | 'COALESCE' | 'COUNT' | 'DATADOG' | 'DATABRICKS' | 'DATAPROC' | 'DATAZEN' | 'DBT' | 'DBT_CORE' | 'DLT' | 'DOMO' | 'DREMIO' | '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' | 'HUBSPOT' | 'INFORMATICA_IICS' | 'INFORMATICA_POWERCENTER' | 'KAFKA' | 'KEBOOLA' | 'KLEENE' | 'LIGHTDASH' | 'LINUX_SSH' | 'MARIADB' | 'MATILLION' | 'MATILLION_ETL' | 'METAPLANE' | 'MICROSOFT_TEAMS' | 'MICROSTRATEGY' | 'MONGODB' | 'MOTHERDUCK' | 'MYSQL' | 'N8N' | 'NIMBLE' | 'NOTION' | 'OMNI' | 'OPEN_AI' | 'ORCHESTRA' | 'PARADIME' | 'PAGER_DUTY' | 'PINECONE' | 'PORTABLE' | 'POSTGRES' | 'POWER_AUTOMATE' | 'POWER_BI' | 'PREFECT_CLOUD' | 'PYTHON' | 'QLIK' | 'QLIK_REPLICATE' | 'QUICKBOOKS' | 'RENDER' | 'RIVERY' | 'RUDDERSTACK' | 'SALESFORCE' | 'SAP' | 'SFTP' | 'SHAREPOINT' | 'SIGMA' | 'SISENSE' | 'SLACK' | 'SNOWFLAKE' | 'SNOWPLOW' | 'SODA' | 'SQL_MESH' | 'SQL_SERVER' | 'STITCH' | 'STREAMKAP' | 'TABLEAU_CLOUD' | 'TALEND_CLOUD' | 'THOUGHTSPOT' | 'TOBIKO_CLOUD' | 'TYPESAFE' | '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' | 'ANTHROPIC' | 'AWS_EC2' | 'AWS_ECS' | 'AWS_EMR' | 'AWS_EKS' | 'AWS_FIREHOSE' | 'AWS_GLUE' | 'AWS_LAMBDA' | 'AWS_RDS' | 'AWS_REDSHIFT' | 'AWS_S3' | 'AWS_BATCH' | 'AWS_BEDROCK' | 'AWS_SAGEMAKER' | 'AWS_SECRETS_MANAGER' | 'AWS_SES' | 'AWS_STEP_FUNCTIONS' | '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' | 'CLICKHOUSE' | 'COALESCE' | 'COUNT' | 'DATADOG' | 'DATABRICKS' | 'DATAPROC' | 'DATAZEN' | 'DBT' | 'DBT_CORE' | 'DLT' | 'DOMO' | 'DREMIO' | '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' | 'HUBSPOT' | 'INFORMATICA_IICS' | 'INFORMATICA_POWERCENTER' | 'KAFKA' | 'KEBOOLA' | 'KLEENE' | 'LIGHTDASH' | 'LINUX_SSH' | 'MARIADB' | 'MATILLION' | 'MATILLION_ETL' | 'METAPLANE' | 'MICROSOFT_TEAMS' | 'MICROSTRATEGY' | 'MONGODB' | 'MOTHERDUCK' | 'MYSQL' | 'N8N' | 'NIMBLE' | 'NOTION' | 'OMNI' | 'OPEN_AI' | 'ORCHESTRA' | 'PARADIME' | 'PAGER_DUTY' | 'PINECONE' | 'PORTABLE' | 'POSTGRES' | 'POWER_AUTOMATE' | 'POWER_BI' | 'PREFECT_CLOUD' | 'PYTHON' | 'QLIK' | 'QLIK_REPLICATE' | 'QUICKBOOKS' | 'RENDER' | 'RIVERY' | 'RUDDERSTACK' | 'SALESFORCE' | 'SAP' | 'SFTP' | 'SHAREPOINT' | 'SIGMA' | 'SISENSE' | 'SLACK' | 'SNOWFLAKE' | 'SNOWPLOW' | 'SODA' | 'SQL_MESH' | 'SQL_SERVER' | 'STITCH' | 'STREAMKAP' | 'TABLEAU_CLOUD' | 'TALEND_CLOUD' | 'THOUGHTSPOT' | 'TOBIKO_CLOUD' | 'TYPESAFE' | 'WEAVIATE' | 'WEBHOOK' | 'WELD' | 'WINDOWS_SSH'
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

Changes

  • e45165e7e223Revision changes
    • breaking

      removed the enum value CLAUDE of the request property

    • warning

      removed the optional property from the response with the status

    • warning

      added the new ANTHROPIC enum value to the / response property for the response status

    • warning

      added the new ANTHROPIC enum value to the response property for the response status

    • warning

      added the new AWS_BATCH enum value to the / response property for the response status

    • warning

      added the new AWS_BATCH enum value to the response property for the response status

    • warning

      added the new AWS_SES enum value to the / response property for the response status

    • warning

      added the new AWS_SES enum value to the response property for the response status

    • warning

      added the new AWS_STEP_FUNCTIONS enum value to the / response property for the response status

    • warning

      added the new AWS_STEP_FUNCTIONS enum value to the response property for the response status

    • warning

      added the new DREMIO enum value to the / response property for the response status

    • warning

      added the new DREMIO enum value to the response property for the response status

    • warning

      added the new HUBSPOT enum value to the / response property for the response status

    • warning

      added the new HUBSPOT enum value to the response property for the response status

    • warning

      added the new MARIADB enum value to the / response property for the response status

    • warning

      added the new MARIADB enum value to the response property for the response status

    • warning

      added the new MONGODB enum value to the / response property for the response status

    • warning

      added the new MONGODB enum value to the response property for the response status

    • warning

      added the new MYSQL enum value to the / response property for the response status

    • warning

      added the new MYSQL enum value to the response property for the response status

    • warning

      added the new N8N enum value to the / response property for the response status

    • warning

      added the new N8N enum value to the response property for the response status

    • warning

      added the new NOTION enum value to the / response property for the response status

    • warning

      added the new NOTION enum value to the response property for the response status

    • warning

      added the new QUICKBOOKS enum value to the / response property for the response status

    • warning

      added the new QUICKBOOKS enum value to the response property for the response status

    • warning

      added the new SALESFORCE enum value to the / response property for the response status

    • warning

      added the new SALESFORCE enum value to the response property for the response status

    • warning

      added the new SHAREPOINT enum value to the / response property for the response status

    • warning

      added the new SHAREPOINT enum value to the response property for the response status

    • warning

      added the new TYPESAFE enum value to the / response property for the response status

    • warning

      added the new TYPESAFE enum value to the response property for the response status

    • info

      the endpoint scheme security ApiKey was added to the API

    • info

      the endpoint scheme security OAuth was added to the API

    • info

      the endpoint scheme security BearerAuth was removed from the API

    • info

      added the new optional header request parameter X-Orchestra-Account-Id

    • info

      added the new ANTHROPIC enum value to the request property

    • info

      added the new AWS_BATCH enum value to the request property

    • info

      added the new AWS_SES enum value to the request property

    • info

      added the new AWS_STEP_FUNCTIONS enum value to the request property

    • info

      added the new DREMIO enum value to the request property

    • info

      added the new HUBSPOT enum value to the request property

    • info

      added the new MARIADB enum value to the request property

    • info

      added the new MONGODB enum value to the request property

    • info

      added the new MYSQL enum value to the request property

    • info

      added the new N8N enum value to the request property

    • info

      added the new NOTION enum value to the request property

    • info

      added the new QUICKBOOKS enum value to the request property

    • info

      added the new SALESFORCE enum value to the request property

    • info

      added the new SHAREPOINT enum value to the request property

    • info

      added the new TYPESAFE enum value to the request property

    • info

      removed the CLAUDE enum value from the / response property for the response status

    • info

      removed the CLAUDE enum value from the response property for the response status