Skip to content
OpenParablePublic APIs

Cloud Dataplex API API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

Overview

Dataplex API is used to manage the lifecycle of data lakes.

Cloud Dataplex API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 40 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Analytics
Base URL
https://dataplex.googleapis.com/
Version
v1
Endpoints
40
OpenAPI
Specification ↗
Spec updated
2023-04-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://dataplex.googleapis.com/v1/NAME" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://dataplex.googleapis.com/v1/NAME", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://dataplex.googleapis.com/v1/NAME",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/v1/{name}Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
PUT/v1/{name}Update a metadata entity. Only supports full resource update.
PATCH/v1/{name}Updates an asset resource.
DELETE/v1/{name}Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If th
GET/v1/{name}/locationsLists information about the supported locations for this service.
GET/v1/{name}/operationsLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
POST/v1/{name}:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the serv
POST/v1/{name}:runRun an on demand execution of a Task.
GET/v1/{parent}/actionsLists action resources in an asset.
GET/v1/{parent}/assetsLists asset resources in a zone.
POST/v1/{parent}/assetsCreates an asset resource.
GET/v1/{parent}/attributesLists Data Attribute resources in a DataTaxonomy.
POST/v1/{parent}/attributesCreate a DataAttribute resource.
GET/v1/{parent}/contentList content.
POST/v1/{parent}/contentCreate a content.
GET/v1/{parent}/contentitemsList content.
POST/v1/{parent}/contentitemsCreate a content.
GET/v1/{parent}/dataAttributeBindingsLists DataAttributeBinding resources in a project and location.
POST/v1/{parent}/dataAttributeBindingsCreate a DataAttributeBinding resource.
GET/v1/{parent}/dataScansLists DataScans.
POST/v1/{parent}/dataScansCreates a DataScan resource.
GET/v1/{parent}/dataTaxonomiesLists DataTaxonomy resources in a project and location.
POST/v1/{parent}/dataTaxonomiesCreate a DataTaxonomy resource.
GET/v1/{parent}/entitiesList metadata entities in a zone.
POST/v1/{parent}/entitiesCreate a metadata entity.
GET/v1/{parent}/environmentsLists environments under the given lake.
POST/v1/{parent}/environmentsCreate an environment resource.
GET/v1/{parent}/jobsLists Jobs under the given task.
GET/v1/{parent}/lakesLists lake resources in a project and location.
POST/v1/{parent}/lakesCreates a lake resource.
GET/v1/{parent}/partitionsList metadata partitions of an entity.
POST/v1/{parent}/partitionsCreate a metadata partition.
GET/v1/{parent}/sessionsLists session resources in an environment.
GET/v1/{parent}/tasksLists tasks under the given lake.
POST/v1/{parent}/tasksCreates a task resource within a lake.
GET/v1/{parent}/zonesLists zone resources in a lake.
POST/v1/{parent}/zonesCreates a zone resource within a lake.
GET/v1/{resource}:getIamPolicyGets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
POST/v1/{resource}:setIamPolicySets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
POST/v1/{resource}:testIamPermissionsReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND e

Questions

Does the Cloud Dataplex API API need an API key?

Yes. The Cloud Dataplex API API uses OAuth authentication; the documentation explains how to get credentials.

Does the Cloud Dataplex API API support HTTPS?

Yes, the Cloud Dataplex API API is served over HTTPS.

How many endpoints does the Cloud Dataplex API API have?

Its OpenAPI description lists 40 endpoints in version v1. All of them are shown on this page.

What are alternatives to the Cloud Dataplex API API?

Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.

Compare alternatives →

Google Play Integrity API

Analytics

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.

OAuth1 endpoints

versionhistory.googleapis.com API

Analytics

Version History API - Prod

No auth4 endpoints

Doc Converter

Analytics

This api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)

No auth1 endpoints

Perspective Comment Analyzer API

Analytics

The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.

OAuth2 endpoints

Safe Browsing API

Analytics

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.

No auth7 endpoints

Web Fonts Developer API

Analytics

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

No auth1 endpoints

Listed from APIs.guru (CC0).