Google

Cloud Dataplex API

A unified, intelligent governance solution for data and AI assets.

Data & analytics#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

A unified, intelligent governance solution for data and AI assets.

Endpoints 68

organizations.locations.encryptionConfigs

  • GETList EncryptionConfigs./v1/:parent/encryptionConfigs?filter=string&orderBy=string&pageSize=0&pageToken=stringList EncryptionConfigs.
  • POSTCreate an EncryptionConfig./v1/:parent/encryptionConfigs?encryptionConfigId=stringCreate an EncryptionConfig.

projects.locations.operations

  • GETGets the latest state of a long-running operation/v1/:nameGets 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.
  • DELETEDeletes a long-running operation/v1/:nameDeletes 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…
  • POSTStarts asynchronous cancellation on a long-running operation/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…
  • GETLists operations that match the specified filter in the request/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

projects.locations.lakes.zones.entities

  • PUTUpdate a metadata entity/v1/:name?validateOnly=trueUpdate a metadata entity. Only supports full resource update.
  • GETList metadata entities in a zone./v1/:parent/entities?filter=string&pageSize=0&pageToken=string&view=ENTITY_VIEW_UNSPECIFIEDList metadata entities in a zone.
  • POSTCreate a metadata entity./v1/:parent/entities?validateOnly=trueCreate a metadata entity.

projects.locations.metadataFeeds

  • PATCHUpdates a MetadataFeed./v1/:name?updateMask=string&validateOnly=trueUpdates a MetadataFeed.
  • GETRetrieve a list of MetadataFeeds./v1/:parent/metadataFeeds?filter=string&orderBy=string&pageSize=0&pageToken=stringRetrieve a list of MetadataFeeds.
  • POSTCreates a MetadataFeed./v1/:parent/metadataFeeds?metadataFeedId=string&validateOnly=trueCreates a MetadataFeed.

projects.locations.lakes.zones.assets

  • GETGets the access control policy for a resource/v1/:resource:getIamPolicy?options.requestedPolicyVersion=0Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
  • POSTSets the access control policy on the specified resource/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.
  • POSTReturns permissions that a caller has on the specified resource/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…
  • GETLists asset resources in a zone./v1/:parent/assets?filter=string&orderBy=string&pageSize=0&pageToken=stringLists asset resources in a zone.
  • POSTCreates an asset resource./v1/:parent/assets?assetId=string&validateOnly=trueCreates an asset resource.

projects.locations

  • GETLists information about the supported locations for this service.This method lists locations based on the resource…/v1/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service.This method lists locations based on the resource scope provided in the…
  • POSTLooks up LLM Context for the specified resources./v1/:name:lookupContextLooks up LLM Context for the specified resources.
  • GETLooks up an entry by name using the permission on the source system./v1/:name:lookupEntry?aspectTypes=string&entry=string&paths=string&view=ENTRY_VIEW_UNSPECIFIEDLooks up an entry by name using the permission on the source system.
  • GETLooks up Entry Links referencing the specified Entry./v1/:name:lookupEntryLinks?entry=string&entryLinkTypes=string&entryMode=ENTRY_MODE_UNSPECIFIED&pageSize=0&pageToken=stringLooks up Entry Links referencing the specified Entry.
  • POSTModifies an entry using the permission on the source system./v1/:name:modifyEntryModifies an entry using the permission on the source system.
  • POSTSearches for Entries matching the given query and scope./v1/:name:searchEntries?contexts=string&orderBy=string&pageSize=0&pageToken=string&query=string&scope=string&semanticSearch=trueSearches for Entries matching the given query and scope.

projects.locations.aspectTypes

  • GETLists AspectType resources in a project and location./v1/:parent/aspectTypes?filter=string&orderBy=string&pageSize=0&pageToken=stringLists AspectType resources in a project and location.
  • POSTCreates an AspectType./v1/:parent/aspectTypes?aspectTypeId=string&validateOnly=trueCreates an AspectType.

projects.locations.changeRequests

  • POSTApproves a ChangeRequest./v1/:name:approveApproves a ChangeRequest.
  • GETLists ChangeRequests./v1/:parent/changeRequests?filter=string&orderBy=string&pageSize=0&pageToken=stringLists ChangeRequests.
  • POSTRejects a ChangeRequest./v1/:name:rejectRejects a ChangeRequest.

projects.locations.dataDomains

  • GETLists DataDomain resources in a project and location./v1/:parent/dataDomains?filter=string&orderBy=string&pageSize=0&pageToken=stringLists DataDomain resources in a project and location.
  • POSTCreates a DataDomain resource./v1/:parent/dataDomains?dataDomainId=string&validateOnly=trueCreates a DataDomain resource.

projects.locations.dataDomains.bindings

  • GETLists DataDomainBinding resources under a DataDomain./v1/:parent/bindings?filter=string&orderBy=string&pageSize=0&pageToken=stringLists DataDomainBinding resources under a DataDomain.
  • POSTCreates a DataDomainBinding resource./v1/:parent/bindings?dataDomainBindingId=string&validateOnly=trueCreates a DataDomainBinding resource.

projects.locations.dataProducts

  • GETLists data products for a given project./v1/:parent/dataProducts?filter=string&orderBy=string&pageSize=0&pageToken=stringLists data products for a given project.
  • POSTCreates a data product./v1/:parent/dataProducts?dataProductId=string&validateOnly=trueCreates a data product.
  • POSTRequests access to a data product/v1/:parent:requestAccessRequests access to a data product. This will trigger an access approval workflow, and the requester will need to wait for the approval to be granted before…

projects.locations.dataProducts.dataAssets

  • GETLists data assets for a given data product./v1/:parent/dataAssets?filter=string&orderBy=string&pageSize=0&pageToken=stringLists data assets for a given data product.
  • POSTCreates a data asset./v1/:parent/dataAssets?dataAssetId=string&validateOnly=trueCreates a data asset.

projects.locations.dataScans

  • GETLists DataScans./v1/:parent/dataScans?filter=string&orderBy=string&pageSize=0&pageToken=stringLists DataScans.
  • POSTCreates a DataScan resource./v1/:parent/dataScans?dataScanId=string&validateOnly=trueCreates a DataScan resource.

projects.locations.dataScans.jobs

  • POSTGenerates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to…/v1/:name:generateDataQualityRulesGenerates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.

projects.locations.lakes.tasks

  • POSTRun an on demand execution of a Task./v1/:name:runRun an on demand execution of a Task.
  • GETLists tasks under the given lake./v1/:parent/tasks?filter=string&orderBy=string&pageSize=0&pageToken=stringLists tasks under the given lake.
  • POSTCreates a task resource within a lake./v1/:parent/tasks?taskId=string&validateOnly=trueCreates a task resource within a lake.

projects.locations.lakes.tasks.jobs

  • GETLists Jobs under the given task./v1/:parent/jobs?pageSize=0&pageToken=stringLists Jobs under the given task.

projects.locations.entryGroups

  • POSTBatch changes metadata within an EntryGroup./v1/:name:batchChangeMetadataBatch changes metadata within an EntryGroup.
  • GETLists EntryGroup resources in a project and location./v1/:parent/entryGroups?filter=string&orderBy=string&pageSize=0&pageToken=stringLists EntryGroup resources in a project and location.
  • POSTCreates an EntryGroup./v1/:parent/entryGroups?entryGroupId=string&validateOnly=trueCreates an EntryGroup.
  • POSTSubmits a catalog change request for multiple resources within an EntryGroup/v1/:name:requestBatchMetadataChangeSubmits a catalog change request for multiple resources within an EntryGroup. This method creates a ChangeRequest resource that must be reviewed and approved…

projects.locations.entryGroups.entries

  • GETLists Entries within an EntryGroup./v1/:parent/entries?filter=string&pageSize=0&pageToken=stringLists Entries within an EntryGroup.
  • POSTCreates an Entry./v1/:parent/entries?entryId=stringCreates an Entry.

projects.locations.entryGroups.entryLinks

  • POSTCreates an Entry Link./v1/:parent/entryLinks?entryLinkId=stringCreates an Entry Link.

projects.locations.entryTypes

  • GETLists EntryType resources in a project and location./v1/:parent/entryTypes?filter=string&orderBy=string&pageSize=0&pageToken=stringLists EntryType resources in a project and location.
  • POSTCreates an EntryType./v1/:parent/entryTypes?entryTypeId=string&validateOnly=trueCreates an EntryType.

projects.locations.glossaries

  • GETLists Glossary resources in a project and location./v1/:parent/glossaries?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Glossary resources in a project and location.
  • POSTCreates a new Glossary resource./v1/:parent/glossaries?glossaryId=string&validateOnly=trueCreates a new Glossary resource.

projects.locations.glossaries.categories

  • GETLists GlossaryCategory resources in a Glossary./v1/:parent/categories?filter=string&orderBy=string&pageSize=0&pageToken=stringLists GlossaryCategory resources in a Glossary.
  • POSTCreates a new GlossaryCategory resource./v1/:parent/categories?categoryId=stringCreates a new GlossaryCategory resource.

projects.locations.glossaries.terms

  • GETLists GlossaryTerm resources in a Glossary./v1/:parent/terms?filter=string&orderBy=string&pageSize=0&pageToken=stringLists GlossaryTerm resources in a Glossary.
  • POSTCreates a new GlossaryTerm resource./v1/:parent/terms?termId=stringCreates a new GlossaryTerm resource.

projects.locations.lakes

  • GETLists lake resources in a project and location./v1/:parent/lakes?filter=string&orderBy=string&pageSize=0&pageToken=stringLists lake resources in a project and location.
  • POSTCreates a lake resource./v1/:parent/lakes?lakeId=string&validateOnly=trueCreates a lake resource.

projects.locations.lakes.zones.assets.actions

  • GETLists action resources in an asset./v1/:parent/actions?pageSize=0&pageToken=stringLists action resources in an asset.

projects.locations.lakes.zones

  • GETLists zone resources in a lake./v1/:parent/zones?filter=string&orderBy=string&pageSize=0&pageToken=stringLists zone resources in a lake.
  • POSTCreates a zone resource within a lake./v1/:parent/zones?validateOnly=true&zoneId=stringCreates a zone resource within a lake.

projects.locations.lakes.zones.entities.partitions

  • GETList metadata partitions of an entity./v1/:parent/partitions?filter=string&pageSize=0&pageToken=stringList metadata partitions of an entity.
  • POSTCreate a metadata partition./v1/:parent/partitions?validateOnly=trueCreate a metadata partition.

projects.locations.metadataJobs

  • GETLists metadata jobs./v1/:parent/metadataJobs?filter=string&orderBy=string&pageSize=0&pageToken=stringLists metadata jobs.
  • POSTCreates a metadata job/v1/:parent/metadataJobs?metadataJobId=string&validateOnly=trueCreates a metadata job. For example, use a metadata job to import metadata from a third-party system into Dataplex Universal Catalog.

API details

Base URL
https://dataplex.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 4 scopes
An API key in the key query parameter
Operations
68 operations on 44 pathsPOST 35GET 30PUT 1PATCH 1DELETE 1
Main resources
projects.locations 6projects.locations.lakes.zones.assets 5projects.locations.entryGroups 4projects.locations.operations 4projects.locations.changeRequests 3projects.locations.dataProducts 3projects.locations.lakes.tasks 3projects.locations.lakes.zones.entities 3projects.locations.metadataFeeds 3organizations.locations.encryptionConfigs 2
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Cloud Dataplex API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Cloud Dataplex API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 4 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List EncryptionConfigs.” (GET /v1/:parent/encryptionConfigs?filter=string&orderBy=string&pageSize=0&pageToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Cloud Dataplex API?

A unified, intelligent governance solution for data and AI assets. It is listed under Data & analytics and has 68 endpoints.

Who publishes the Cloud Dataplex API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Cloud Dataplex API?

Requests go to https://dataplex.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Cloud Dataplex API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 4 scopes; an API key in the key query parameter.

How many endpoints does the Cloud Dataplex API have?

68 operations on 44 paths (35 POST, 30 GET, 1 PUT, 1 PATCH, 1 DELETE). The largest groups are projects.locations, projects.locations.lakes.zones.assets, projects.locations.entryGroups, projects.locations.operations.

Is forking the Cloud Dataplex API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.