Virtual Sources

Create, update, and delete virtual sources and virtual objects programmatically via the Decube API.

The Virtual Sources API lets you manage virtual sources and their objects programmatically. Use these endpoints to bulk-create asset hierarchies, integrate virtual source management into your data pipelines, or automate the lifecycle of virtual assets.

All write operations require the admin_data_source:edit permission. Read operations require admin_data_source:view.

Virtual objects created via API follow the same Decube data model as those created in the UI. See Overview for an overview of supported object types.

Virtual Sources

Create a virtual source

Creates a new virtual source. The source name must be unique across all sources in your workspace.

Create Virtual Source

post

Creates a new virtual source using the provided request body.

Body

application/json

namestringRequired

Responses

200

Successful Response

application/json

source_idintegerRequired

422

Validation Error

application/json

post/virtual_sources

HTTPcURLJavaScriptPython

POST /api/v1/data/virtual_sources HTTP/1.1
Host: connect.<REGION>.decube.io
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "source_id": 1
}

Update a virtual source

Updates the name or description of an existing virtual source.

Update Virtual Source

put

Updates an existing virtual source using the provided request body.

Body

application/json

source_idintegerRequired

namestringRequired

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

put/virtual_sources

HTTPcURLJavaScriptPython

PUT /api/v1/data/virtual_sources HTTP/1.1
Host: connect.<REGION>.decube.io
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "source_id": 1,
  "name": "text"
}

No content

Delete a virtual source

Permanently deletes a virtual source and all virtual objects under it. This is irreversible.

Delete Virtual Source

delete

Deletes a virtual source by ID.

Query parameters

source_idintegerRequired

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

delete/virtual_sources

HTTPcURLJavaScriptPython

DELETE /api/v1/data/virtual_sources?source_id=1 HTTP/1.1
Host: connect.<REGION>.decube.io
Accept: */*

No content

Virtual Objects

All virtual object endpoints operate only on assets under a virtual source. Passing an identifier that resolves to a native source asset returns a 400.

Create a virtual object

Creates a virtual object under a virtual source. Pass a type field to specify the asset type — supported values are COLLECTION (Schema), DATASET (Table), PROPERTY (Column), DATA_JOB, DATA_TASK, DASHBOARD, and CHART. The asset type cannot be changed after creation.

Create Virtual Asset

post

Creates a new virtual asset using the provided request body.

Body

application/json

or

or

or

or

or

or

Responses

200

Successful Response

application/json

attrsany ofRequired

or

or

or

or

or

or

or

object · DataTaskAttributesOptional

or

or

or

or

422

Validation Error

application/json

post/virtual_assets

HTTPcURLJavaScriptPython

POST /api/v1/data/virtual_assets HTTP/1.1
Host: connect.<REGION>.decube.io
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "type": "text",
  "parent": {
    "type": "text",
    "id": 1
  },
  "name": "text"
}

{
  "asset": {
    "id": 1,
    "name": "text",
    "type": "source"
  },
  "parents": [
    {
      "id": 1,
      "name": "text",
      "type": "source"
    }
  ],
  "attrs": {
    "source_type": "bigquery",
    "data_owners": [
      {
        "email": "text",
        "id": "text"
      }
    ],
    "business_owners": [
      {
        "email": "text",
        "id": "text"
      }
    ],
    "description": "text",
    "linked_terms": [
      {
        "id": 1,
        "type": "source"
      }
    ],
    "custom_attributes": [
      {
        "id": 1,
        "type": "text",
        "value": 1
      }
    ]
  }
}

Update a virtual object

Updates one or more fields on an existing virtual object. Only fields included in the request are updated.

Patch Virtual Asset

patch

Updates (partially) an existing virtual asset using the provided request body.

Body

application/json

or

or

or

or

or

or

Responses

200

Successful Response

application/json

attrsany ofRequired

or

or

or

or

or

or

or

object · DataTaskAttributesOptional

or

or

or

or

422

Validation Error

application/json

patch/virtual_assets

HTTPcURLJavaScriptPython

PATCH /api/v1/data/virtual_assets HTTP/1.1
Host: connect.<REGION>.decube.io
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "type": "text",
  "asset": {
    "type": "text",
    "id": 1
  },
  "name": {
    "value": "text"
  }
}

{
  "asset": {
    "id": 1,
    "name": "text",
    "type": "source"
  },
  "parents": [
    {
      "id": 1,
      "name": "text",
      "type": "source"
    }
  ],
  "attrs": {
    "source_type": "bigquery",
    "data_owners": [
      {
        "email": "text",
        "id": "text"
      }
    ],
    "business_owners": [
      {
        "email": "text",
        "id": "text"
      }
    ],
    "description": "text",
    "linked_terms": [
      {
        "id": 1,
        "type": "source"
      }
    ],
    "custom_attributes": [
      {
        "id": 1,
        "type": "text",
        "value": 1
      }
    ]
  }
}

Delete a virtual object

Soft-deletes a virtual object and all its children. Soft-deleted objects are removed from the Catalog, lineage, and search results but remain in the database until the parent virtual source is deleted.

Delete Virtual Asset

delete

Deletes a virtual asset by ID.

Query parameters

asset_idintegerRequired

asset_typestring · enumRequiredPossible values:

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

delete/virtual_assets

HTTPcURLJavaScriptPython

DELETE /api/v1/data/virtual_assets?asset_id=1&asset_type=collection HTTP/1.1
Host: connect.<REGION>.decube.io
Accept: */*

No content