Google

Google Cloud Data Catalog API

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

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 fully managed and highly scalable data discovery and metadata management service.

Endpoints 19

catalog

  • POSTSearches Data Catalog for multiple resources like entries and tags that match a query/v1/catalog:searchSearches Data Catalog for multiple resources like entries and tags that match a query. This is a [Custom Method]…

organizations.locations

  • GETRetrieves the configuration related to the migration from Data Catalog to Dataplex Universal Catalog for a specific…/v1/:name:retrieveConfigRetrieves the configuration related to the migration from Data Catalog to Dataplex Universal Catalog for a specific organization, including all the projects…

projects.locations

  • GETRetrieves the effective configuration related to the migration from Data Catalog to Dataplex Universal Catalog for a…/v1/:name:retrieveEffectiveConfigRetrieves the effective configuration related to the migration from Data Catalog to Dataplex Universal Catalog for a specific organization or project. If…
  • POSTSets the configuration related to the migration to Dataplex Universal Catalog for an organization or project./v1/:name:setConfigSets the configuration related to the migration to Dataplex Universal Catalog for an organization or project.

projects.locations.operations

  • 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.taxonomies.policyTags

  • GETGets a policy tag./v1/:nameGets a policy tag.
  • DELETEDeletes a policy tag together with the following: * All of its descendant policy tags, if any * Policies associated…/v1/:nameDeletes a policy tag together with the following: * All of its descendant policy tags, if any * Policies associated with the policy tag and its descendants *…
  • PATCHUpdates a policy tag, including its display name, description, and parent policy tag./v1/:name?updateMask=stringUpdates a policy tag, including its display name, description, and parent policy tag.
  • POSTGets the IAM policy for a policy tag or a taxonomy./v1/:resource:getIamPolicyGets the IAM policy for a policy tag or a taxonomy.
  • POSTSets the IAM policy for a policy tag or a taxonomy./v1/:resource:setIamPolicySets the IAM policy for a policy tag or a taxonomy.
  • POSTReturns your permissions on a specified policy tag or taxonomy./v1/:resource:testIamPermissionsReturns your permissions on a specified policy tag or taxonomy.
  • GETLists all policy tags in a taxonomy./v1/:parent/policyTags?pageSize=0&pageToken=stringLists all policy tags in a taxonomy.
  • POSTCreates a policy tag in a taxonomy./v1/:parent/policyTagsCreates a policy tag in a taxonomy.

projects.locations.taxonomies

  • GETLists all taxonomies in a project in a particular location that you have a permission to view./v1/:parent/taxonomies?filter=string&pageSize=0&pageToken=stringLists all taxonomies in a project in a particular location that you have a permission to view.
  • POSTCreates a taxonomy in a specified project/v1/:parent/taxonomiesCreates a taxonomy in a specified project. The taxonomy is initially empty, that is, it doesn't contain policy tags.
  • GETExports taxonomies in the requested type and returns them, including their policy tags/v1/:parent/taxonomies:export?serializedTaxonomies=true&taxonomies=stringExports taxonomies in the requested type and returns them, including their policy tags. The requested taxonomies must belong to the same project. This method…
  • POSTCreates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional…/v1/:parent/taxonomies:importCreates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources. For a cross-regional source, new…
  • POSTReplaces (updates) a taxonomy and all its policy tags/v1/:name:replaceReplaces (updates) a taxonomy and all its policy tags. The taxonomy and its entire hierarchy of policy tags must be represented literally by…

API details

Base URL
https://datacatalog.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter
Operations
19 operations on 15 pathsPOST 10GET 7PATCH 1DELETE 1
Main resources
projects.locations.taxonomies.policyTags 8projects.locations.taxonomies 5projects.locations 2projects.locations.operations 2catalog 1organizations.locations 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Google Cloud Data Catalog 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 Google Cloud Data Catalog API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Searches Data Catalog for multiple resources like entries and tags that match a query” (POST /v1/catalog:search), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Google Cloud Data Catalog API?

A fully managed and highly scalable data discovery and metadata management service. It is listed under Data & analytics and has 19 endpoints.

Who publishes the Google Cloud Data Catalog 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 Google Cloud Data Catalog API?

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

How do I authenticate with the Google Cloud Data Catalog API?

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

How many endpoints does the Google Cloud Data Catalog API have?

19 operations on 15 paths (10 POST, 7 GET, 1 PATCH, 1 DELETE). The largest groups are projects.locations.taxonomies.policyTags, projects.locations.taxonomies, projects.locations, projects.locations.operations.

Is forking the Google Cloud Data Catalog 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.