Cloudera

Cloudera Data Catalog API

The Data Catalog API from Cloudera — 20 operation(s) for data catalog.

GitHub OpenAPI
Business capability
Data Governance Management BC-610.10

Operations 20

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /api/v1/datacatalog/launchProfilers Launch data profilers in a data lake · Launches DataCatalog profilers in a given datalake #
Ask an LLM
“How do I start the Data Catalog profilers on my data lake?”
“Can I enable high availability and cap the node count for profilers?”
Tell an agent
Launch Data Catalog profilers in data lake {datalake}.
Launch profilers {profilers} in {datalake} with HA {enableHA} and at most {maxNodes} nodes.
POST /api/v1/datacatalog/getDataShare Get one Data Share's details · Get a Data Share by its ID #
Ask an LLM
“What assets and external users are in a specific Data Share?”
“Can I view the terms and settings of a single Data Share?”
Tell an agent
Show Data Share {dataShareId} in data lake {datalakeCrn} and environment {environmentCrn}.
Get the assets and recipients of Data Share {dataShareId} ({datalakeCrn}, {environmentCrn}).
POST /api/v1/datacatalog/listDataShares List Data Shares in a data lake · List Data Shares #
Ask an LLM
“Which Data Shares exist in my data lake?”
“Can I filter Data Shares by name?”
Tell an agent
List Data Shares in data lake {datalakeCrn} of environment {environmentCrn}.
Find Data Shares named {name} in {datalakeCrn} ({environmentCrn}).
POST /api/v1/datacatalog/createExternalUsers Register external users for data sharing · Create external users for Data Sharing #
Ask an LLM
“How do I let people outside Cloudera access shared data?”
“Can I create several external data-sharing users at once?”
Tell an agent
Create external users {externalUsers} in data lake {datalakeCrn}, environment {environmentCrn}.
Register outside partners {externalUsers} as data-sharing users for {datalakeCrn} in {environmentCrn}.
POST /api/v1/datacatalog/listExternalUsers List external data-sharing users · List external users for Data Sharing #
Ask an LLM
“Who are the external users registered for data sharing?”
“Can I search external users by a term?”
Tell an agent
List external users for data lake {datalakeCrn} in environment {environmentCrn}.
Search external users for {searchTerm} in {datalakeCrn} ({environmentCrn}).
POST /api/v1/datacatalog/regenerateExternalUserCredentials Regenerate an external user's credentials · Regenerate credentials for an external user #
Ask an LLM
“How do I issue fresh credentials to an external data-sharing user?”
“Do an external user's old credentials stop working when I regenerate them?”
Tell an agent destructive · confirm first
Regenerate credentials for external user {externalUserId} in {datalakeCrn}, environment {environmentCrn}.
Rotate external user {externalUserId}'s login for data lake {datalakeCrn} ({environmentCrn}).
POST /api/v1/datacatalog/deleteExternalUser Permanently delete an external user · Delete an external user #
Ask an LLM
“How do I permanently remove an outside user from data sharing?”
“Does deleting an external user cut off all their Data Shares?”
Tell an agent destructive · confirm first
Delete external user {externalUserId} from {datalakeCrn} in environment {environmentCrn}.
Permanently remove external user {externalUserId} ({datalakeCrn}, {environmentCrn}).
POST /api/v1/datacatalog/updateDataShare Edit a Data Share's metadata · Update the Data Share #
Ask an LLM
“Can I change the expiration time or terms of use on an existing Data Share?”
“How do I rename a Data Share or update its keywords?”
Tell an agent
Rename Data Share {dataShareId} to {dataShareName} in {datalakeCrn} ({environmentCrn}).
Set Data Share {dataShareId} to expire at {expiryTime} ({datalakeCrn}, {environmentCrn}).
POST /api/v1/datacatalog/revokeExternalUserCredentials Revoke an external user's credentials · Revoke credentials for an external user #
Ask an LLM
“How do I immediately cut off an external user's access to shared data?”
“Is revoking credentials different from deleting the external user?”
Tell an agent destructive · confirm first
Revoke credentials for external user {externalUserId} in {datalakeCrn}, environment {environmentCrn}.
Cut off external user {externalUserId}'s access right now ({datalakeCrn}, {environmentCrn}).
POST /api/v1/datacatalog/createDataShare Create a Data Share · Create a Data Share for Data Sharing #
Ask an LLM
“How do I share tables with people inside or outside Cloudera?”
“Can I attach terms of use and an expiry when I create a Data Share?”
Tell an agent
Create Data Share {dataShareName} with assets {assets} in {datalakeCrn} ({environmentCrn}).
Create share {dataShareName} of {assets} for external users {externalUsers} in {datalakeCrn}, environment {environmentCrn}.
POST /api/v1/datacatalog/deleteDataShare Delete a Data Share · Delete a Data Share by its ID #
Ask an LLM
“How do I permanently delete a Data Share?”
“Must a Data Share be unshared before I can delete it?”
Tell an agent destructive · confirm first
Delete Data Share {dataShareId} from {datalakeCrn} in environment {environmentCrn}.
Permanently remove share {dataShareId} ({datalakeCrn}, {environmentCrn}).
POST /api/v1/datacatalog/shareDataShare Publish a Data Share to its external users · Share the Data Share for external users #
Ask an LLM
“How do I make a Data Share's assets available to its external users?”
“What does switching a Data Share to Shared do?”
Tell an agent
Share Data Share {dataShareId} with its external users ({datalakeCrn}, {environmentCrn}).
Set the status of {dataShareId} to Shared in data lake {datalakeCrn}, environment {environmentCrn}.
POST /api/v1/datacatalog/unshareDataShare Temporarily unshare a Data Share · Unshare the Data Share for external users #
Ask an LLM
“Can I temporarily hide a Data Share from external users without deleting it?”
“Which Data Share edits require it to be Not Shared first?”
Tell an agent
Unshare Data Share {dataShareId} in {datalakeCrn} ({environmentCrn}).
Set share {dataShareId} to Not Shared for data lake {datalakeCrn}, environment {environmentCrn}.
POST /api/v1/datacatalog/addAssetsToDataShare Add assets to an existing Data Share · Add assets to an existing Data Share #
Ask an LLM
“How do I add more tables to a Data Share I already created?”
“Does a Data Share need to be unshared before adding assets?”
Tell an agent
Add assets {assets} to Data Share {dataShareId} in {datalakeCrn} ({environmentCrn}).
Include {assets} in existing share {dataShareId} for data lake {datalakeCrn}, environment {environmentCrn}.
POST /api/v1/datacatalog/getSuggestedTags Get tags suggested by the compliance profiler · Get Suggested tags by the Data Compliance profiler #
Ask an LLM
“Which sensitive-data tags has the Data Compliance profiler suggested?”
“Can I see suggested tags for one table or column profiled since a date?”
Tell an agent
Get suggested compliance tags in data lake {datalakeCrn}.
Show profiler-suggested tags for table {tableFQN} in {datalakeCrn} since {profiledSince}.
POST /api/v1/datacatalog/reviewSuggestedTags Accept or reject profiler-suggested tags · Review tags suggested by Data Compliance Profiler #
Ask an LLM
“How do I approve or reject the tags the compliance profiler suggested?”
“Can I review suggested tags for many assets at once?”
Tell an agent
Apply action {action} to suggested tags on assets {assets} in {datalakeCrn}.
Accept the compliance profiler's tag suggestions for {assets} in data lake {datalakeCrn} with action {action}.
POST /api/v1/datacatalog/removeAssetsFromDataShare Remove assets from a Data Share · Remove assets from an existing Data Share #
Ask an LLM
“How do I take a table out of an existing Data Share?”
“Must the share be Not Shared before removing assets?”
Tell an agent destructive · confirm first
Remove resources {resourceIds} from Data Share {dataShareId} in {datalakeCrn} ({environmentCrn}).
Drop assets {resourceIds} from share {dataShareId} for data lake {datalakeCrn}, environment {environmentCrn}.
POST /api/v1/datacatalog/updateAccessOfExternalUsersOnDataShare Change external users' access expiry on a share · Update access of external users on a Data Share #
Ask an LLM
“Can I extend how long an external user can access a Data Share?”
“How do I update access expiration for users already on a share?”
Tell an agent
Update access expiry for external users {externalUsers} on Data Share {dataShareId} ({datalakeCrn}, {environmentCrn}).
Extend the access window of {externalUsers} on share {dataShareId} in data lake {datalakeCrn}, environment {environmentCrn}.
POST /api/v1/datacatalog/grantAccessToExternalUsersOnDataShare Grant external users access to a Data Share · Grant access to external users on a Data Share #
Ask an LLM
“How do I give an outside user access to a Data Share?”
“Can I set an expiration when granting external users access?”
Tell an agent
Grant external users {externalUsers} access to Data Share {dataShareId} in {datalakeCrn} ({environmentCrn}).
Let outside partners {externalUsers} read share {dataShareId} for data lake {datalakeCrn}, environment {environmentCrn}.
POST /api/v1/datacatalog/removeAccessOfExternalUsersOnDataShare Remove external users from a Data Share · Remove access of external users on a Data Share #
Ask an LLM
“How do I take away one external user's access to a specific Data Share?”
“Does the Data Share need to be Not Shared before removing users?”
Tell an agent destructive · confirm first
Remove external users {externalUserIds} from Data Share {dataShareId} in {datalakeCrn} ({environmentCrn}).
Revoke share {dataShareId} access for {externalUserIds} in data lake {datalakeCrn}, environment {environmentCrn}.

Documentation

📖
Documentation
https://docs.cloudera.com/cdp-public-cloud/cloud/api/topics/mc-api-overview.html
📖
APIReference
https://cloudera.github.io/cdp-dev-docs/api-docs/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/openapi/cloudera-data-catalog-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-get-data-share-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-create-data-share-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-launch-profilers-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-update-data-share-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-list-external-users-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-list-data-shares-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-create-azure-cluster-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-create-awscluster-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-collect-datahub-diagnostics-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-create-awsgov-cloud-cluster-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-create-gcpcluster-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-collect-cm-diagnostics-request-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cloudera:cloudera-data-catalog-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cloudera-data-catalog-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 0.9.163
  title: Cloudera Service Datacatalog API
  license:
    name: Apache 2.0
  description: Cloudera DataCatalog Service is a web service, using this service a user can execute operations like launching profilers in DataCatalog.
tags:


# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/openapi/cloudera-data-catalog-api-openapi.yml