Cloudera

Cloudera Opdb API

The Opdb API from Cloudera — 19 operation(s) for opdb.

GitHub OpenAPI

Operations 19

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/opdb/collectDiagnostics Collect a diagnostic bundle from an operational database · Collect diagnostic data bundles from the database #
Ask an LLM
“How do I gather diagnostic bundles from my operational database for support?”
“Can I attach a support case number to an OpDB diagnostics collection?”
Tell an agent
Collect diagnostics from database {databaseName} in {environmentName} up to {endTime}.
Gather a diagnostic bundle for {databaseName} in {environmentName} from {startTime} to {endTime} for case {caseNumber}.
POST /api/v1/opdb/createDatabase Create an operational database · Create opDb #
Ask an LLM
“How do I spin up a new operational database in a CDP environment?”
“Can I turn on autoscaling and Grafana when I create an operational database?”
Tell an agent
Create operational database {databaseName} in environment {environmentName}.
Create a new OpDB called {databaseName} in {environmentName} with {numEdgeNodes} edge nodes.
POST /api/v1/opdb/createSnapshot Snapshot a table in an operational database · Creates a snapshot for a specific table #
Ask an LLM
“How can I take a snapshot of a single table in my operational database?”
“Where do OpDB table snapshots get written?”
Tell an agent
Snapshot table {tableName} in {databaseName} ({environmentName}) as {snapshotName} at {snapshotLocation}.
Take a table snapshot named {snapshotName} of {tableName} in database {databaseName}, environment {environmentName}, stored at {snapshotLocation}.
POST /api/v1/opdb/deleteSnapshot Delete a table snapshot · Deletes a snapshot #
Ask an LLM
“How do I get rid of an old table snapshot in my operational database?”
“Can a snapshot deletion be forced?”
Tell an agent destructive · confirm first
Delete snapshot {snapshotName} from database {databaseName} in {environmentName}.
Force-remove snapshot {snapshotName} on {databaseName} in environment {environmentName}.
POST /api/v1/opdb/describeClientConnectivity Get client connection details for a database · Returns client connectivity details #
Ask an LLM
“How do my applications connect programmatically to my operational database?”
“What client connectivity details does an OpDB expose?”
Tell an agent
Show client connectivity details for {databaseName} in {environmentName}.
Get the connection info my app needs for OpDB {databaseName} in {environmentName}.
POST /api/v1/opdb/describeDatabase Describe an operational database · Describe a opDb #
Ask an LLM
“What's the current configuration and state of my operational database?”
“Can I see the details of a single OpDB by name?”
Tell an agent
Describe operational database {databaseName} in {environmentName}.
Show me the details of OpDB {databaseName} in environment {environmentName}.
POST /api/v1/opdb/describeUpgradeDatabase Check whether a database upgrade is available · Describes the upgrade availability #
Ask an LLM
“Is there an upgrade available for my operational database?”
“Which runtime could my OpDB be upgraded to?”
Tell an agent
Check upgrade availability for database {database} in {environment}.
Tell me if OpDB {database} in {environment} can be upgraded.
POST /api/v1/opdb/dropDatabase Drop an operational database · drop a opDb #
Ask an LLM
“How do I permanently drop an operational database?”
“Can I force the drop of an OpDB that won't delete cleanly?”
Tell an agent destructive · confirm first
Drop operational database {databaseName} in {environmentName}.
Force-drop OpDB {databaseName} from environment {environmentName}.
POST /api/v1/opdb/listDatabases List operational databases · List all opDbs in an environment #
Ask an LLM
“Which operational databases are running in my environment?”
“Can I list every OpDB across all environments?”
Tell an agent
List the operational databases in {environmentName}.
Show all my operational databases.
POST /api/v1/opdb/listDiagnostics List diagnostic collections for a database · List all diagnostics associated to the database #
Ask an LLM
“What diagnostic bundles have already been collected for my operational database?”
“Can I see past diagnostics collections for one OpDB?”
Tell an agent
List diagnostics collections for {databaseName} in {environmentName}.
Show previous diagnostic bundles gathered from OpDB {databaseName} in {environmentName}.
POST /api/v1/opdb/listRestoreSnapshots List snapshot restores into a database · Lists instances when a snapshot was restored to a database #
Ask an LLM
“When was a snapshot last restored into my operational database?”
“Can I filter snapshot restore history by a restore time window?”
Tell an agent
List snapshot restores into {databaseName} in {environmentName}.
Show restore history of snapshot {snapshotName} into {databaseName} ({environmentName}) since {fromRestoreTime}.
POST /api/v1/opdb/listSnapshots List table snapshots in a database · Shows snapshot for a table name in a specific location #
Ask an LLM
“What table snapshots exist for my operational database?”
“Can I list snapshots for one table created within a date range?”
Tell an agent
List snapshots in {databaseName} in {environmentName}.
Show snapshots of table {tableName} in {databaseName} ({environmentName}) created after {fromCreationTime}.
POST /api/v1/opdb/listSupportedEnvironments List environments that can host an operational database · List of environments available for the database creation #
Ask an LLM
“Which of my environments can I create an operational database in?”
“Are any environments eligible for a new OpDB yet?”
Tell an agent
List environments available for operational database creation.
Show which environments support creating an OpDB.
POST /api/v1/opdb/prepareUpgradeDatabase Prepare an operational database for upgrade · Prepare database upgrade #
Ask an LLM
“How do I run the pre-upgrade validations on my operational database?”
“Can parcels be staged ahead of an OpDB upgrade to a specific runtime?”
Tell an agent
Prepare database {database} in {environment} for upgrade.
Validate and stage parcels to upgrade OpDB {database} in {environment} to runtime {runtime}.
POST /api/v1/opdb/restoreSnapshot Restore a snapshot into a database · Restores a snapshot #
Ask an LLM
“How do I restore a table snapshot into another operational database?”
“Can a snapshot be restored into a database in a different environment?”
Tell an agent
Restore snapshot {snapshotName} from {databaseName} ({environmentName}) into {targetDatabaseName} in {targetEnvironmentName}.
Recover data from snapshot {snapshotName} of {databaseName} in {environmentName} into target database {targetDatabaseName}, environment {targetEnvironmentName}.
POST /api/v1/opdb/startDatabase Start a stopped operational database · Starts the database #
Ask an LLM
“How do I bring a stopped operational database back online?”
“Can I restart an OpDB I paused earlier?”
Tell an agent
Start operational database {databaseName} in {environmentName}.
Resume the stopped OpDB {databaseName} in environment {environmentName}.
POST /api/v1/opdb/stopDatabase Stop a running operational database · Stops the database #
Ask an LLM
“Can I stop my operational database when it isn't being used?”
“What happens to a running OpDB when I shut it down?”
Tell an agent
Stop operational database {databaseName} in {environmentName}.
Shut down the running OpDB {databaseName} in environment {environmentName}.
POST /api/v1/opdb/updateDatabase Update an operational database's scaling · Updates the database #
Ask an LLM
“How do I change autoscaling settings on an existing operational database?”
“Can I change how many REST worker nodes my OpDB runs?”
Tell an agent
Update database {databaseName} in {environmentName} to run {numDesiredRestworkerNodes} REST worker nodes.
Set {numDesiredStrongMetaServers} strong meta servers on OpDB {databaseName} in {environmentName}.
POST /api/v1/opdb/upgradeDatabase Upgrade an operational database runtime · Upgrades the database #
Ask an LLM
“How do I upgrade my operational database to a newer runtime?”
“Is an OS-only upgrade possible for an OpDB?”
Tell an agent
Upgrade database {database} in {environment} to runtime {runtime}.
Run an OS-only upgrade on OpDB {database} in {environment}.

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-opdb-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-create-database-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-update-database-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-list-restore-snapshots-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-restore-snapshot-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-collect-diagnostics-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-describe-upgrade-database-response-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-opdb-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-opdb-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 0.9.163
  title: Operational Database service Opdb API
  license:
    name: Apache 2.0
  description: Interact with the Cloudera Operational Database service
  termsOfService: https://www.cloudera.com/legal/commercial-terms-and-conditions.html
tags:


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