How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Cloudera

Cloudera Operational Database API

Create and manage Cloudera Operational Database (HBase) instances on an environment. 19 operations.

Documentation Provider Profile APIs.io OpenAPI GitHub

Cloudera Operational Database API is one of 24 APIs that Cloudera publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Operational Database, HBase, and NoSQL. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 19 operations across 19 paths, and defines 66 schemas. It is described by OpenAPI 2.0, at version 0.9.163.

Requests are made against the base URL https://api.us-west-1.cdp.cloudera.com.

19 operations 19 paths 66 schemas 19 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
0.9.163
Base URL
https://api.us-west-1.cdp.cloudera.com
License
Apache 2.0
Terms of Service
View terms
Resource Areas
1

Paths & Operations 19

Across 19 paths, the API surfaces 19 operations — 19 POST. Each is listed below with its method, path, parameters, and response codes.

Operations 19
POST
/api/v1/opdb/collectDiagnostics
Collect diagnostic data bundles from the database
collectDiagnostics 1 param → 200default
POST
/api/v1/opdb/createDatabase
Create opDb
createDatabase 1 param → 200default
POST
/api/v1/opdb/createSnapshot
Creates a snapshot for a specific table.
createSnapshot 1 param → 200default
POST
/api/v1/opdb/deleteSnapshot
Deletes a snapshot.
deleteSnapshot 1 param → 200default
POST
/api/v1/opdb/describeClientConnectivity
Returns client connectivity details
describeClientConnectivity 1 param → 200default
POST
/api/v1/opdb/describeDatabase
Describe a opDb
describeDatabase 1 param → 200default
POST
/api/v1/opdb/describeUpgradeDatabase
Describes the upgrade availability.
describeUpgradeDatabase 1 param → 200default
POST
/api/v1/opdb/dropDatabase
drop a opDb
dropDatabase 1 param → 200default
POST
/api/v1/opdb/listDatabases
List all opDbs in an environment
listDatabases 1 param → 200default
POST
/api/v1/opdb/listDiagnostics
List all diagnostics associated to the database
listDiagnostics 1 param → 200default
POST
/api/v1/opdb/listRestoreSnapshots
Lists instances when a snapshot was restored to a database.
listRestoreSnapshots 1 param → 200default
POST
/api/v1/opdb/listSnapshots
Shows snapshot for a table name in a specific location.
listSnapshots 1 param → 200default
POST
/api/v1/opdb/listSupportedEnvironments
List of environments available for the database creation
listSupportedEnvironments 1 param → 200default
POST
/api/v1/opdb/prepareUpgradeDatabase
Prepare database upgrade.
prepareUpgradeDatabase 1 param → 200default
POST
/api/v1/opdb/restoreSnapshot
Restores a snapshot.
restoreSnapshot 1 param → 200default
POST
/api/v1/opdb/startDatabase
Starts the database
startDatabase 1 param → 200default
POST
/api/v1/opdb/stopDatabase
Stops the database
stopDatabase 1 param → 200default
POST
/api/v1/opdb/updateDatabase
Updates the database
updateDatabase 1 param → 200default
POST
/api/v1/opdb/upgradeDatabase
Upgrades the database.
upgradeDatabase 1 param → 200default

Schemas 66

The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are CreateDatabaseRequest (22 properties), DatabaseDetails (14 properties), RestoreSnapshotResponse (9 properties), RestoreSnapshot (9 properties). Each schema is shown below with its type and property counts.

Error
object
An object returned on an error.
2 properties
DiagnosticDestination
string
Destination of the created diagnostics bundle.
DiagnosticsBundle
object
Describe a diagnostics bundle.
8 properties
CollectDiagnosticsRequest
object
Enables starting collection of the diagnostics. This is an asynchronous API and not expected to block.
7 properties 3 required
CollectDiagnosticsResponse
object
Information about diagnostic bundle generation.
1 property
ListDiagnosticsRequest
object
Lists the in-progress diagnostic bundle operations.
2 properties 2 required
ListDiagnosticsResponse
object
The list of in-progress diagnostic bundle operations.
1 property
KeyValuePair
object
Generic key-value type, because map< is not supported
2 properties
InstanceGroupType
string
InstanceGroup Type. WORKER - WORKER value of the InstanceGroup name. LEADER - LEADER value of the InstanceGroup name. MASTER - MASTER value of the InstanceGrou…
CustomRecipe
object
Describe a custom recipe.
2 properties 2 required
VolumeEncryption
object
Specify volume encryption key for instance group.
2 properties 2 required
CreateDatabaseRequest
object
A request to create the database
22 properties 2 required
CustomInstanceTypes
object
Custom VM Instance Types.
6 properties
VolumeType
string
Volume Type. HDD - Hard disk drives (HDD) volume type. Default is HDD. SSD - Solid disk drives (SSD) volume type. LOCALSSD - Local SSD volume type.
AttachedStorageForWorkers
object
Attached storage for the worker nodes for AWS, Azure, and GCP cloud providers.
3 properties
ScaleType
string
Scale type. MICRO - Create a 2-node cluster (1 gateway and 1 worker) with high availability disabled. LIGHT - Create a multi-node cluster with a light master a…
StorageType
string
Storage type for clusters. CLOUDWITHEPHEMERAL - Cloud with ephemeral storage. CLOUD - Cloud storage without ephemeral storage. HDFS - HDFS storage.
ArchitectureType
string
Architecture type for cluster. X8664 - X64 CPU Architecture is used for the cluster. ARM64 - ARM64 CPU Architecture is used for the cluster.
UpdateDatabaseRequest
object
A request to update the database
7 properties 2 required
AutoScalingParameters
object
A Parameters to configure AutoScaling
6 properties
CreateDatabaseResponse
object
A response which gives status of the database creation
1 property 1 required
UpdateDatabaseResponse
object
A response to database update request
1 property
DropDatabaseRequest
object
A request to drop the database
3 properties 2 required
DropDatabaseResponse
object
A response which gives status of the database deletion
1 property
ListSupportedEnvironmentsRequest
object
A request to get a list of available environments
Environment
object
Details of the environment
2 properties 2 required
ListSupportedEnvironmentsResponse
object
A response which contains a list of available environments
1 property
StatusType
string
status of the database
ListDatabasesRequest
object
A request to list databases
1 property
ListDatabasesResponse
object
A list of databases in response
1 property 1 required
DatabaseDetails
object
Details of the databases.
14 properties 4 required
DescribeDatabaseRequest
object
request to get details of the database in a particular environment
2 properties 2 required
DescribeDatabaseResponse
object
Details of the database.
1 property
SnapshotStatusType
string
Snapshot Status Type. NEW - Expected when a snapshot request was just requested. INPROGRESS - When a snapshot request is in progress. FAILED - If for any reaso…
CreateSnapshotRequest
object
Create Snapshot Request.
5 properties 5 required
CreateSnapshotResponse
object
Create Snapshot Response.
6 properties
RestoreSnapshotRequest
object
Restore Snapshot Request.
5 properties 5 required
RestoreSnapshotResponse
object
Response object for the RestoreSnapshot method.
9 properties
DeleteSnapshotRequest
object
Request object for the DeleteSnapshot method.
4 properties 3 required
DeleteSnapshotResponse
object
Response object of the DeleteSnapshot method.
6 properties
Snapshot
object
An instance of a table's snapshot.
8 properties 3 required
ListSnapshotsRequest
object
Show Snapshots Request.
6 properties 2 required
ListSnapshotsResponse
object
Show Snapshots Response.
5 properties 2 required
ListRestoreSnapshotsRequest
object
Show Restore Snapshots Request.
8 properties 2 required
RestoreSnapshot
object
An instance of restoring a snapshot to a database.
9 properties 2 required
ListRestoreSnapshotsResponse
object
Show Restore Snapshots Response.
3 properties 2 required
StartDatabaseRequest
object
Start the database.
2 properties 2 required
StartDatabaseResponse
object
A response from starting the database.
2 properties
StopDatabaseRequest
object
Stop the database.
2 properties 2 required
StopDatabaseResponse
object
A response from stopping the database.
2 properties
DescribeClientConnectivityRequest
object
A request for client API connectivity to a database.
2 properties 2 required
KerberosConfiguration
object
Configuration information to enable Kerberos authentication
3 properties
Kind
string
A categorization of a connector to describe how it is broadly used. LIBRARY - A client library or API which user's code invokes JDBC - A JDBC driver SERVICE -…
DependencyManagement
object
Information about dependencies necessary to use a connector.
1 property
ClientConfigurationDetails
object
A URL which holds information necessary to configure a Connector.
2 properties
ConnectorConfiguration
object
Runtime details necessary to use a connector.
3 properties
Connector
object
Information to use to connect to a database via some mechanism.
6 properties
DescribeClientConnectivityResponse
object
A response with client API connectivity to a database.
2 properties
UpgradeDatabaseRequest
object
Asynchronous request to upgrade the CDP Runtime for a database.
4 properties
PrepareUpgradeDatabaseRequest
object
Asynchronous request to prepare cluster upgrade.
4 properties 2 required
UpgradeDatabaseResponse
object
Response with the reason whether upgrade request is accepted or why it is not possible.
1 property
PrepareUpgradeDatabaseResponse
object
Response with the reason whether prepare upgrade request is accepted or why it is not possible.
1 property
DescribeUpgradeDatabaseRequest
object
Request to describe the upgrade availability of CDP Runtime and Operating System for a database.
2 properties 2 required
DescribeUpgradeDatabaseResponse
object
Response with upgrade availability of CDP Runtime and Operating System for a database.
5 properties
ComponentsVersion
object
Versions of the CDP runtime and Operating system components.
4 properties
Image
object
Details of an Image.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudera-opdb-openapi.yml Raw ↑

Other APIs Cloudera publishes across the network.

Cloudera Audit Service API
AE Profile APIs.io
Cloudera Private Links API
AE Profile APIs.io
Cloudera Compute Service API
AE Profile APIs.io
Cloudera Consumption API
AE Profile APIs.io
Cloudera Data Catalog API
AE Profile APIs.io
Cloudera Data Hub API
AE Profile APIs.io
Cloudera Datalake API
AE Profile APIs.io
Cloudera Data Engineering API
AE Profile APIs.io
Cloudera DataFlow API
AE Profile APIs.io
Cloudera DataFlow Workload API
AE Profile APIs.io
Cloudera Control Plane Data Recovery API
AE Profile APIs.io
Cloudera Data Warehouse API
AE Profile APIs.io
#Operational Database#HBase#NoSQL
← Back to C APIs
API Details
ID
cloudera:cloudera-operational-database-api
Base URL
https://api.us-west-1.cdp.cloudera.com
Docs
https://docs.cloudera.com/cdp-public-cloud/cloud/api/topics/mc-api-overview.html
Provider
Cloudera
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=cloudera-operational-database-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/cloudera-operational-database-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Cloudera Operational Database API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.