Cloud Dataplex API

Name: Cloud Dataplex API API
Brand: Cloud Dataplex API
Availability: InStock

✓ Official Vendor SpecAnalyticsData Pipelinesoauth253 EndpointsREST

For Agents

Manage data lakes, zones, assets, and metadata catalog entries in Cloud Dataplex. Lets agents run data quality scans, search the catalog, and apply governance policies programmatically.

Quickstart

Get started with Cloud Dataplex API in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"run a dataplex data quality scan"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with Cloud Dataplex API API.

Create lakes, zones, and assets that group BigQuery and Cloud Storage data under governance

Run data quality and data profile scans and generate quality rule recommendations

Search the unified Dataplex Catalog by entry name, aspect, or fully qualified name

Define aspect types and entry types that classify catalog metadata

GET STARTED

Start building with Cloud Dataplex API API

Explore with Jentic

View OpenAPI Document

Use for: I need to run a data quality scan on a BigQuery table, Search the Dataplex catalog for entries containing 'orders', Create a lake and a raw zone over a Cloud Storage bucket, Generate data quality rules from a data profile scan result

Not supported: Does not run BigQuery queries, transform data in place, or replace BigQuery's IAM — use for lake, zone, asset governance, data scans, and unified catalog search only.

Cloud Dataplex is Google's data lake management service: it organises data spread across BigQuery, Cloud Storage, and other sources into governed lakes, zones, and assets. The API exposes 53 endpoints covering lakes and zones, content (notebooks and SQL scripts), data scans for quality and profiling, data taxonomies and policies, plus a unified entry-and-aspect catalog for metadata search. Agents and platform teams use it to enforce governance and discover data without standing up a separate metadata store.

Use Cases

Patterns agents use Cloud Dataplex API API for, with concrete tasks.

★ Automated Data Quality Scans

Define data quality rules on BigQuery tables and run them on a schedule, with results surfaced through the Dataplex UI and the API. The service returns a DataScanJob with rule-by-rule pass and fail counts so platform teams can route failures into incident channels. generateDataQualityRules lets agents bootstrap rules from a profile scan instead of writing them by hand.

Trigger DataScan 'orders-quality' via POST /v1/{+name}:run, poll the resulting DataScanJob until state is SUCCEEDED, and report any rule failures back to the operator

Unified Metadata Catalog Search

Search across all entries in a project's Dataplex catalog using POST /v1/{+name}:searchEntries with full-text and structured filters. The catalog covers BigQuery datasets and tables, Cloud Storage filesets, and custom entry types, so an agent can locate the right dataset without prior knowledge of which service it lives in. Results include entry name, type, and aspects.

Search Dataplex entries for query 'orders' across project 'acme-data', filter by entry type bigquery-table, and return the top 20 fully qualified names

Lake-Zone-Asset Governance Setup

Stand up a Dataplex lake with raw and curated zones, then attach Cloud Storage and BigQuery assets so they inherit lake-level IAM and lifecycle policies. The API exposes create, list, update, and delete operations on lakes, zones, and assets, plus environments for lake-scoped notebooks. This is the foundation for governed data platforms on Google Cloud.

Create lake 'sales-lake', then a zone 'raw' of type RAW, then attach asset of resource type STORAGE_BUCKET pointing to gs://acme-sales-raw/

AI Agent Data Governance Operator

An AI agent can manage lakes, run scans, and search the catalog through Jentic without operator hand-holding. Jentic search returns the matching Dataplex operation by intent, the agent loads the schema, and Jentic executes against dataplex.googleapis.com using vault-stored credentials. This compresses governance work that would otherwise require multiple SDK calls and bespoke OAuth handling.

Use Jentic to search 'run a dataplex data quality scan', load the run-DataScan schema, and execute it on DataScan 'orders-quality'

Key Endpoints

53 endpoints — cloud dataplex is google's data lake management service: it organises data spread across bigquery, cloud storage, and other sources into governed lakes, zones, and assets.

METHOD

PATH

DESCRIPTION

POST

/v1/{+parent}/lakes

Create a Dataplex lake

POST

/v1/{+parent}/dataScans

Create a data quality or profile scan

POST

/v1/{+name}:run

Run a DataScan or task on demand

POST

/v1/{+name}:searchEntries

Search the Dataplex catalog

GET

/v1/{+name}:lookupEntry

Look up a catalog entry by fully qualified name

POST

/v1/{+name}:generateDataQualityRules

Generate quality rules from a profile scan

POST

/v1/{+parent}/lakes

Create a Dataplex lake

POST

/v1/{+parent}/dataScans

Create a data quality or profile scan

POST

/v1/{+name}:run

Run a DataScan or task on demand

POST

/v1/{+name}:searchEntries

Search the Dataplex catalog

GET

/v1/{+name}:lookupEntry

Look up a catalog entry by fully qualified name

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Google OAuth client secrets and refresh tokens are stored encrypted in the Jentic vault. Agents receive scoped, short-lived access tokens for dataplex.googleapis.com; raw credentials never enter the agent context.

Intent-based discovery

Agents search Jentic by intent (e.g. 'run a dataplex data quality scan') and Jentic returns the matching operation with its input schema, so the agent calls the right endpoint without browsing the discovery doc.

Time to first call

Direct Dataplex integration: 2-4 days for OAuth, lake/zone/asset modelling, and scan-job polling. Through Jentic: under 1 hour.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Data Catalog API

Data Catalog is the legacy metadata search service; Dataplex Catalog is its successor with unified entries and aspects.

Choose Data Catalog when working with existing tag templates and entries already managed there. Prefer Dataplex Catalog for new governance work.

Complementary

BigQuery API

BigQuery holds tables that Dataplex governs and scans for quality.

Choose BigQuery for query, table, and dataset operations. Use Dataplex to govern those tables across a wider lake.

Complementary

Cloud Storage API

Cloud Storage buckets are common Dataplex assets attached to raw zones.

Choose Cloud Storage for object-level operations. Use Dataplex to attach buckets to a governed zone.

FAQs

Specific to using Cloud Dataplex API API through Jentic.

What authentication does the Cloud Dataplex API use?

Cloud Dataplex uses OAuth 2.0 with the cloud-platform scope. Through Jentic the OAuth client and refresh tokens are stored in the Jentic vault and the agent receives short-lived scoped access tokens, so raw Google credentials never enter the agent context.

Can I run data quality scans with the Cloud Dataplex API?

Yes. Create a DataScan of type DATA_QUALITY or DATA_PROFILE, then call POST /v1/{+name}:run to trigger a job. generateDataQualityRules can bootstrap rules from a profile result, so agents do not have to author them by hand.

What are the rate limits for the Cloud Dataplex API?

Google enforces standard Cloud quotas on dataplex.googleapis.com: per-project rate limits on read/write calls and quotas on concurrent DataScan and task executions. Quotas are visible in the Cloud Console under IAM and admin, quotas, filtered to dataplex.googleapis.com.

How do I search the Dataplex catalog through Jentic?

Search Jentic for 'search dataplex catalog entries', load the schema for POST /v1/{+name}:searchEntries, and execute with the project name, query string, and optional scope filter. Jentic returns the list of matching entries and their aspects.

Is the Cloud Dataplex API free?

Lake, zone, and catalog metadata operations are free. Data quality and data profile scan executions are billed by data-scanned and runtime, plus the underlying BigQuery and Spark costs. See the Dataplex pricing page for the latest rates.

How do I look up a single catalog entry by name?

Call GET /v1/{+name}:lookupEntry with the fully qualified entry name (for example projects/acme/locations/us/entryGroups/@bigquery/entries/...) to fetch the entry plus its aspects in one call. This is faster than searchEntries when the FQN is already known.