Google Cloud Data Catalog API

A fully managed and highly scalable data discovery and metadata management service.

Service: datacatalog.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://datacatalog.googleapis.com

REST Resource: v1beta1.catalog

Methods
search POST /v1beta1/catalog:search
Searches Data Catalog for multiple resources like entries, tags that match a query.

REST Resource: v1beta1.entries

Methods
lookup GET /v1beta1/entries:lookup
Get an entry by target resource name.

REST Resource: v1beta1.projects.locations.entryGroups

Methods
create POST /v1beta1/{parent}/entryGroups
A maximum of 10,000 entry groups may be created per organization across all locations.
delete DELETE /v1beta1/{name}
Deletes an EntryGroup.
get GET /v1beta1/{name}
Gets an EntryGroup.
getIamPolicy POST /v1beta1/{resource}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1beta1/{parent}/entryGroups
Lists entry groups.
patch PATCH /v1beta1/{entryGroup.name}
Updates an EntryGroup.
setIamPolicy POST /v1beta1/{resource}:setIamPolicy
Sets the access control policy for a resource.
testIamPermissions POST /v1beta1/{resource}:testIamPermissions
Returns the caller's permissions on a resource.

REST Resource: v1beta1.projects.locations.entryGroups.entries

Methods
create POST /v1beta1/{parent}/entries
Creates an entry.
delete DELETE /v1beta1/{name}
Deletes an existing entry.
get GET /v1beta1/{name}
Gets an entry.
getIamPolicy POST /v1beta1/{resource}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1beta1/{parent}/entries
Lists entries.
patch PATCH /v1beta1/{entry.name}
Updates an existing entry.
testIamPermissions POST /v1beta1/{resource}:testIamPermissions
Returns the caller's permissions on a resource.

REST Resource: v1beta1.projects.locations.entryGroups.entries.tags

Methods
create POST /v1beta1/{parent}/tags
Creates a tag on an Entry.
delete DELETE /v1beta1/{name}
Deletes a tag.
list GET /v1beta1/{parent}/tags
Lists tags assigned to an Entry.
patch PATCH /v1beta1/{tag.name}
Updates an existing tag.

REST Resource: v1beta1.projects.locations.entryGroups.tags

Methods
create POST /v1beta1/{parent}/tags
Creates a tag on an Entry.
delete DELETE /v1beta1/{name}
Deletes a tag.
list GET /v1beta1/{parent}/tags
Lists tags assigned to an Entry.
patch PATCH /v1beta1/{tag.name}
Updates an existing tag.

REST Resource: v1beta1.projects.locations.tagTemplates

Methods
create POST /v1beta1/{parent}/tagTemplates
Creates a tag template.
delete DELETE /v1beta1/{name}
Deletes a tag template and all tags using the template.
get GET /v1beta1/{name}
Gets a tag template.
getIamPolicy POST /v1beta1/{resource}:getIamPolicy
Gets the access control policy for a resource.
patch PATCH /v1beta1/{tagTemplate.name}
Updates a tag template.
setIamPolicy POST /v1beta1/{resource}:setIamPolicy
Sets the access control policy for a resource.
testIamPermissions POST /v1beta1/{resource}:testIamPermissions
Returns the caller's permissions on a resource.

REST Resource: v1beta1.projects.locations.tagTemplates.fields

Methods
create POST /v1beta1/{parent}/fields
Creates a field in a tag template.
delete DELETE /v1beta1/{name}
Deletes a field in a tag template and all uses of that field.
patch PATCH /v1beta1/{name}
Updates a field in a tag template.
rename POST /v1beta1/{name}:rename
Renames a field in a tag template.

REST Resource: v1beta1.projects.locations.tagTemplates.fields.enumValues

Methods
rename POST /v1beta1/{name}:rename
Renames an enum value in a tag template.

REST Resource: v1beta1.projects.locations.taxonomies

Methods
create POST /v1beta1/{parent}/taxonomies
Creates a taxonomy in the specified project.
delete DELETE /v1beta1/{name}
Deletes a taxonomy.
export GET /v1beta1/{parent}/taxonomies:export
Exports all taxonomies and their policy tags in a project.
get GET /v1beta1/{name}
Gets a taxonomy.
getIamPolicy POST /v1beta1/{resource}:getIamPolicy
Gets the IAM policy for a taxonomy or a policy tag.
import POST /v1beta1/{parent}/taxonomies:import
Imports all taxonomies and their policy tags to a project as new taxonomies.
list GET /v1beta1/{parent}/taxonomies
Lists all taxonomies in a project in a particular location that the caller has permission to view.
patch PATCH /v1beta1/{taxonomy.name}
Updates a taxonomy.
setIamPolicy POST /v1beta1/{resource}:setIamPolicy
Sets the IAM policy for a taxonomy or a policy tag.
testIamPermissions POST /v1beta1/{resource}:testIamPermissions
Returns the permissions that a caller has on the specified taxonomy or policy tag.

REST Resource: v1beta1.projects.locations.taxonomies.policyTags

Methods
create POST /v1beta1/{parent}/policyTags
Creates a policy tag in the specified taxonomy.
delete DELETE /v1beta1/{name}
Deletes a policy tag.
get GET /v1beta1/{name}
Gets a policy tag.
getIamPolicy POST /v1beta1/{resource}:getIamPolicy
Gets the IAM policy for a taxonomy or a policy tag.
list GET /v1beta1/{parent}/policyTags
Lists all policy tags in a taxonomy.
patch PATCH /v1beta1/{policyTag.name}
Updates a policy tag.
setIamPolicy POST /v1beta1/{resource}:setIamPolicy
Sets the IAM policy for a taxonomy or a policy tag.
testIamPermissions POST /v1beta1/{resource}:testIamPermissions
Returns the permissions that a caller has on the specified taxonomy or policy tag.

REST Resource: v1.catalog

Methods
search POST /v1/catalog:search
Searches Data Catalog for multiple resources like entries and tags that match a query.

REST Resource: v1.entries

Methods
lookup GET /v1/entries:lookup
Gets an entry by its target resource name.

REST Resource: v1.organizations.locations

Methods
retrieveConfig GET /v1/{name}:retrieveConfig
Retrieves the configuration related to the migration from Data Catalog to Dataplex for a specific organization, including all the projects under it which have a separate configuration set.
retrieveEffectiveConfig GET /v1/{name}:retrieveEffectiveConfig
Retrieves the effective configuration related to the migration from Data Catalog to Dataplex for a specific organization or project.
setConfig POST /v1/{name}:setConfig
Sets the configuration related to the migration to Dataplex for an organization or project.

REST Resource: v1.projects.locations

Methods
retrieveEffectiveConfig GET /v1/{name}:retrieveEffectiveConfig
Retrieves the effective configuration related to the migration from Data Catalog to Dataplex for a specific organization or project.
setConfig POST /v1/{name}:setConfig
Sets the configuration related to the migration to Dataplex for an organization or project.

REST Resource: v1.projects.locations.entryGroups

Methods
create POST /v1/{parent}/entryGroups
Creates an entry group.
delete DELETE /v1/{name}
Deletes an entry group.
get GET /v1/{name}
Gets an entry group.
getIamPolicy POST /v1/{resource}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent}/entryGroups
Lists entry groups.
patch PATCH /v1/{entryGroup.name}
Updates an entry group.
setIamPolicy POST /v1/{resource}:setIamPolicy
Sets an access control policy for a resource.
testIamPermissions POST /v1/{resource}:testIamPermissions
Gets your permissions on a resource.

REST Resource: v1.projects.locations.entryGroups.entries

Methods
create POST /v1/{parent}/entries
Creates an entry.
delete DELETE /v1/{name}
Deletes an existing entry.
get GET /v1/{name}
Gets an entry.
getIamPolicy POST /v1/{resource}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent}/entries
Lists entries.
modifyEntryContacts POST /v1/{name}:modifyEntryContacts
Modifies contacts, part of the business context of an Entry.
modifyEntryOverview POST /v1/{name}:modifyEntryOverview
Modifies entry overview, part of the business context of an Entry.
patch PATCH /v1/{entry.name}
Updates an existing entry.
star POST /v1/{name}:star
Marks an Entry as starred by the current user.
testIamPermissions POST /v1/{resource}:testIamPermissions
Gets your permissions on a resource.
unstar POST /v1/{name}:unstar
Marks an Entry as NOT starred by the current user.

REST Resource: v1.projects.locations.entryGroups.entries.tags

Methods
create POST /v1/{parent}/tags

Creates a tag and assigns it to:

  • An Entry if the method name is projects.locations.entryGroups.entries.tags.create.
delete DELETE /v1/{name}
Deletes a tag.
list GET /v1/{parent}/tags
Lists tags assigned to an Entry.
patch PATCH /v1/{tag.name}
Updates an existing tag.
reconcile POST /v1/{parent}/tags:reconcile
ReconcileTags creates or updates a list of tags on the entry.

REST Resource: v1.projects.locations.entryGroups.tags

Methods
create POST /v1/{parent}/tags

Creates a tag and assigns it to:

  • An Entry if the method name is projects.locations.entryGroups.entries.tags.create.
delete DELETE /v1/{name}
Deletes a tag.
list GET /v1/{parent}/tags
Lists tags assigned to an Entry.
patch PATCH /v1/{tag.name}
Updates an existing tag.

REST Resource: v1.projects.locations.operations

Methods
cancel POST /v1/{name}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1/{name}
Deletes a long-running operation.
get GET /v1/{name}
Gets the latest state of a long-running operation.
list GET /v1/{name}/operations
Lists operations that match the specified filter in the request.

REST Resource: v1.projects.locations.tagTemplates

Methods
create POST /v1/{parent}/tagTemplates
Creates a tag template.
delete DELETE /v1/{name}
Deletes a tag template and all tags that use it.
get GET /v1/{name}
Gets a tag template.
getIamPolicy POST /v1/{resource}:getIamPolicy
Gets the access control policy for a resource.
patch PATCH /v1/{tagTemplate.name}
Updates a tag template.
setIamPolicy POST /v1/{resource}:setIamPolicy
Sets an access control policy for a resource.
testIamPermissions POST /v1/{resource}:testIamPermissions
Gets your permissions on a resource.

REST Resource: v1.projects.locations.tagTemplates.fields

Methods
create POST /v1/{parent}/fields
Creates a field in a tag template.
delete DELETE /v1/{name}
Deletes a field in a tag template and all uses of this field from the tags based on this template.
patch PATCH /v1/{name}
Updates a field in a tag template.
rename POST /v1/{name}:rename
Renames a field in a tag template.

REST Resource: v1.projects.locations.tagTemplates.fields.enumValues

Methods
rename POST /v1/{name}:rename
Renames an enum value in a tag template.

REST Resource: v1.projects.locations.taxonomies

Methods
create POST /v1/{parent}/taxonomies
Creates a taxonomy in a specified project.
delete DELETE /v1/{name}
Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns.
export GET /v1/{parent}/taxonomies:export
Exports taxonomies in the requested type and returns them, including their policy tags.
get GET /v1/{name}
Gets a taxonomy.
getIamPolicy POST /v1/{resource}:getIamPolicy
Gets the IAM policy for a policy tag or a taxonomy.
import POST /v1/{parent}/taxonomies:import
Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources.
list GET /v1/{parent}/taxonomies
Lists all taxonomies in a project in a particular location that you have a permission to view.
patch PATCH /v1/{taxonomy.name}
Updates a taxonomy, including its display name, description, and activated policy types.
replace POST /v1/{name}:replace
Replaces (updates) a taxonomy and all its policy tags.
setIamPolicy POST /v1/{resource}:setIamPolicy
Sets the IAM policy for a policy tag or a taxonomy.
testIamPermissions POST /v1/{resource}:testIamPermissions
Returns your permissions on a specified policy tag or taxonomy.

REST Resource: v1.projects.locations.taxonomies.policyTags

Methods
create POST /v1/{parent}/policyTags
Creates a policy tag in a taxonomy.
delete DELETE /v1/{name}

Deletes a policy tag together with the following:

  • All of its descendant policy tags, if any
  • Policies associated with the policy tag and its descendants
  • References from BigQuery table schema of the policy tag and its descendants
get GET /v1/{name}
Gets a policy tag.
getIamPolicy POST /v1/{resource}:getIamPolicy
Gets the IAM policy for a policy tag or a taxonomy.
list GET /v1/{parent}/policyTags
Lists all policy tags in a taxonomy.
patch PATCH /v1/{policyTag.name}
Updates a policy tag, including its display name, description, and parent policy tag.
setIamPolicy POST /v1/{resource}:setIamPolicy
Sets the IAM policy for a policy tag or a taxonomy.
testIamPermissions POST /v1/{resource}:testIamPermissions
Returns your permissions on a specified policy tag or taxonomy.