Cloudera

Cloudera Drscp API

The Drscp API from Cloudera — 9 operation(s) for drscp.

GitHub OpenAPI

Operations 9

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/drscp/createBackup Back up the control plane · Creates a backup for the control plane #
Ask an LLM
“How do I take an on-demand backup of my CDP control plane?”
“Does a control plane backup include the embedded database and Kubernetes objects?”
Tell an agent
Create a control plane backup now.
Back up control plane item {itemName} as {backupName}.
POST /api/v1/drscp/restoreBackup Restore the control plane from a backup · Restores backup #
Ask an LLM
“How do I rebuild my control plane from an existing backup?”
“What do I need to start a control plane restore?”
Tell an agent
Restore the control plane from backup {backupCrn}.
Recreate the control plane using backup {backupCrn}.
POST /api/v1/drscp/deleteBackup Delete a control plane backup · Deletes a control plane backup #
Ask an LLM
“Can I delete an old control plane backup?”
“Does deleting a control plane backup return right away?”
Tell an agent destructive · confirm first
Delete control plane backup {backupCrn}.
Permanently remove backup {backupCrn}.
POST /api/v1/drscp/describeBackup Describe a control plane backup · Describes the backup #
Ask an LLM
“What state is a particular control plane backup in?”
“Can I see what a control plane backup contains?”
Tell an agent
Describe control plane backup {backupCrn}.
Show the status of backup {backupCrn}.
POST /api/v1/drscp/describeRestore Describe a control plane restore · Restores the backup #
Ask an LLM
“Has my control plane restore finished?”
“What details are reported for a restore operation?”
Tell an agent
Describe control plane restore {restoreCrn}.
Show progress of restore job {restoreCrn}.
POST /api/v1/drscp/listBackupEntities List what can be backed up · Lists potential backup entities associated with the control plane #
Ask an LLM
“Which control plane namespaces are eligible for backup?”
“Is the vault namespace included in backup entities?”
Tell an agent
List the potential backup entities for the control plane.
Show which namespaces I can include in a control plane backup.
POST /api/v1/drscp/listBackups List control plane backups · Lists backups #
Ask an LLM
“What control plane backups exist?”
“Can I filter control plane backups by job state or name?”
Tell an agent
List all control plane backups.
List backups named {backupName} in states {jobStates}.
POST /api/v1/drscp/listRestores List control plane restores · Lists restores #
Ask an LLM
“Which control plane restores have been run?”
“Can I list only the restores made from one backup?”
Tell an agent
List all control plane restores.
List restores from backup {backupCrn} in states {jobStates}.
POST /api/v1/drscp/getLogs Get logs for a backup or restore job · Gets job logs #
Ask an LLM
“Where can I read the logs of a failed control plane backup or restore?”
“Can I fetch job logs using the job's CRN?”
Tell an agent
Get the job logs for {crn}.
Show backup or restore logs for job {crn}.

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

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-list-backup-entities-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-create-backup-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-list-backups-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-list-restores-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-list-restores-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-list-backups-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-drscp-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-drscp-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 0.9.163
  title: CDP Control Plane Data Recovery Service Drscp API
  license:
    name: Apache 2.0
  description: The API of Data Recovery Service for CDP Private Cloud Control Plane .
tags:
- name: Drscp
paths:
  /api/v1/drscp/createBackup:
    post:
      summary: Creates a backup for the control plane
      description: Creates an on-demand backup for the control plane including embedded database, Kubernetes objects, persistent volume, etc. Backup requests are processed asynchronously and instantaneously.
      operationId: createBackup
      x-right: drscp/createBackup
      x-mutating: true
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateBackupResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBackupRequest'
        required: true
      tags:
      - Drscp
  /api/v1/drscp/restoreBackup:
    post:
      summary: Restores backup
      description: Creates a new control plane from an existing backup.
      operationId: restoreBackup
      x-right: drscp/restoreBackup
      x-mutating: true
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestoreBackupResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestoreBackupRequest'
        required: true
      tags:
      - Drscp
  /api/v1/drscp/deleteBackup:
    post:
      summary: Deletes a control plane backup
      description: Deletes an existing control plane backup. The call returns immediately.
      operationId: deleteBackup
      x-right: drscp/deleteBackup
      x-mutating: true
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteBackupResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteBackupRequest'
        required: true
      tags:
      - Drscp
  /api/v1/drscp/describeBackup:
    post:
      summary: Describes the backup
      description: Returns the description of an existing control plane backup.
      operationId: describeBackup
      x-right: drscp/describeBackup
      x-mutating: false
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeBackupResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeBackupRequest'
        required: true
      tags:
      - Drscp
  /api/v1/drscp/describeRestore:
    post:
      summary: Restores the backup
      description: Returns the description of a control plane restore operation.
      operationId: describeRestore
      x-right: drscp/describeRestore
      x-mutating: false
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeRestoreResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeRestoreRequest'
        required: true
      tags:
      - Drscp
  /api/v1/drscp/listBackupEntities:
    post:
      summary: Lists potential backup entities associated with the control plane
      description: Lists potential backup entities. It includes the main control plane namespace and its corresponding vault namespace(if embedded).
      operationId: listBackupEntities
      x-right: drscp/listBackupEntities
      x-mutating: false
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBackupEntitiesResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListBackupEntitiesRequest'
        required: true
      tags:
      - Drscp
  /api/v1/drscp/listBackups:
    post:
      summary: Lists backups
      description: Lists backups associated with the control plane.
      operationId: listBackups
      x-right: drscp/listBackups
      x-mutating: false
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBackupsResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListBackupsRequest'
        required: true
      tags:
      - Drscp
  /api/v1/drscp/listRestores:
    post:
      summary: Lists restores
      description: Lists restores associated with the control plane.
      operationId: listRestores
      x-right: drscp/listRestores
      x-mutating: false
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRestoresResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListRestoresRequest'
        required: true
      tags:
      - Drscp
  /api/v1/drscp/getLogs:
    post:
      summary: Gets job logs
      description: Given the Crn, returns the corresponding job logs.
      operationId: getLogs
      x-right: drscp/getLogs
      x-mutating: false
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLogsResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetLogsRequest'
        required: true
      tags:
      - Drscp
components:
  schemas:
    DeleteBackupResponse:
      type: object
      description: Response object for the delete backup request.
      required:
      - deleteBackupCrn
      properties:
        deleteBackupCrn:
          type: string
          description: The CRN of the kubernetes delete backup custom resource.
    Backup:
      type: object
      description: Backup entry
      properties:
        backupCrn:
          type: string
          description: The unique CRN of the backup.
        backupCreationTime:
          type: string
          description: The time when the backup was created.
        backupName:
          type: string
          description: The display name of the backup.
        backupUpdatedTime:
          type: string
          description: The time when the backup was updated.
        backupPhase:
          type: string
          description: The phase of the backup operation. The values are PENDING, PRE_VALIDATION, SAVING_OBJECTS, CREATING_SNAPSHOTS and FINISHED. PENDING indicates waiting for the job to start executing. PRE_VALIDATION indicates validation of the environment before backup. SAVING_OBJECTS indicates saving all the kubernetes resources related to the backup item. CREATING_SNAPSHOTS indicates creating a snapshot of all Kubernetes PersistentVolumeClaims related to the backup item and FINISHED indicates that the backup job has finished.
        backupJobState:
          type: string
          description: The current state of the backup job. The values are NOT_STARTED, IN_PROGRESS, COMPLETED, PARTIALLY_FAILED, FAILED and TERMINATING. NOT_STARTED indicates the job has not started. IN_PROGRESS indicates the job is running. COMPLETED indicates the job has finished running successfully. PARTIALLY_FAILED indicates the job has finished running with some warnings. FAILED indicates the job has finished running with errors and TERMINATING indicates that the entity containing this job is being deleted.
        backupJob:
          type: string
          description: The backup job name.
        includedNamespaces:
          type: array
          description: The list of namespaces to be included in backup.
          items:
            type: string
        warnings:
          type: array
          description: The warnings from backup job.
          items:
            $ref: '#/components/schemas/Message'
        errors:
          type: array
          description: The errors from backup job.
          items:
            $ref: '#/components/schemas/Message'
    RestoreBackupRequest:
      type: object
      description: Request object for the restore backup request.
      required:
      - backupCrn
      properties:
        backupCrn:
          type: string
          description: The CRN of the backup.
    GetLogsResponse:
      type: object
      description: Response object for the get backup logs request.
      required:
      - logs
      properties:
        logs:
          type: string
          description: Contains the logs of the operation.
          x-skip-logging: true
    SimpleBackup:
      type: object
      description: A simple backup entry for listBackup usage
      properties:
        backupCrn:
          type: string
          description: The unique CRN of the backup.
        backupName:
          type: string
          description: The display name of the backup.
        backupCreationTime:
          type: string
          description: The time when the backup was created.
        backupPhase:
          type: string
          description: The phase of the backup operation. The values are PENDING, PRE_VALIDATION, SAVING_OBJECTS, CREATING_SNAPSHOTS and FINISHED. PENDING indicates waiting for the job to start executing. PRE_VALIDATION indicates validation of the environment before backup. SAVING_OBJECTS indicates saving all the kubernetes resources related to the backup item. CREATING_SNAPSHOTS indicates creating a snapshot of all Kubernetes PersistentVolumeClaims related to the backup item and FINISHED indicates that the backup job has finished.
        backupJobState:
          type: string
          description: The current state of the backup job. The values are NOT_STARTED, IN_PROGRESS, COMPLETED, PARTIALLY_FAILED, FAILED and TERMINATING. NOT_STARTED indicates the job has not started. IN_PROGRESS indicates the job is running. COMPLETED indicates the job has finished running successfully. PARTIALLY_FAILED indicates the job has finished running with some warnings. FAILED indicates the job has finished running with errors and TERMINATING indicates that the entity containing this job is being deleted.
    Restore:
      type: object
      description: Restore entry
      properties:
        restoreCrn:
          type: string
          description: The CRN of the restore.
        backupCrn:
          type: string
          description: The CRN of the backup.
        restoreCreationTime:
          type: string
          description: The time when the restore was created.
        restoreUpdatedTime:
          type: string
          description: The updated time of the restore.
        excludedResources:
          type: array
          description: The list of resources to be excluded in restore.
          items:
            type: string
        includedNamespaces:
          type: array
          description: The list of namespaces to be included in restore.
          items:
            type: string
        successConditions:
          type: array
          description: The list of conditions to be met for a successful restore.
          items:
            type: string
        restorePhase:
          type: string
          description: The phase of the restore operation. The values are PENDING, PRE_VALIDATION, STOPPING_APPS, DELETING_OBJECTS, DELETING_OBJECTS_PVC, RESTORING_PVC, RESTORING_OBJECTS, STARTING_APPS and FINISHED. PENDING indicates waiting for the job to start executing. PRE_VALIDATION indicates validation of the environment before restore. STOPPING_APPS indicates stopping the microservices before data restore. DELETING_OBJECTS indicates deletion of Kubernetes resources other than PersistentVolumeClaims. DELETING_OBJECTS_PVC indicates deletion of Kubernetes PersistentVolumeClaims. RESTORING_PVC indicates creation of Kubernetes PersistentVolumeClaims. RESTORING_OBJECTS indicates creating of Kubernetes objects other than PersistentVolumeClaims. STARTING_APPS indicates starting of the microservices after data restore and FINISHED indicates the restore job has finished.
        restoreJobState:
          type: string
          description: The current state of the restore job. The values are NOT_STARTED, IN_PROGRESS, COMPLETED, PARTIALLY_FAILED, FAILED and TERMINATING. NOT_STARTED indicates the job has not started. IN_PROGRESS indicates the job is running. COMPLETED indicates the job has finished running successfully. PARTIALLY_FAILED indicates the job has finished running with some warnings. FAILED indicates the job has finished running with errors and TERMINATING indicates that the entity containing this job is being deleted.
        restoreJob:
          type: string
          description: The restore job name.
        warnings:
          type: array
          description: The warnings from restore job.
          items:
            $ref: '#/components/schemas/Message'
        errors:
          type: array
          description: The errors from restore job.
          items:
            $ref: '#/components/schemas/Message'
    CreateBackupResponse:
      type: object
      description: Response object for the create backup request.
      required:
      - backupCrn
      properties:
        backupCrn:
          type: string
          description: The CRN of the backup.
    ListRestoresResponse:
      type: object
      description: Response object for the list restores request.
      required:
      - restores
      properties:
        restores:
          type: array
          description: List of restores for the control plane.
          items:
            $ref: '#/components/schemas/SimpleRestore'
    Error:
      type: object
      description: An object returned on an error.
      properties:
        code:
          type: string
          description: The error code.
        message:
          type: string
          description: The error message.
    RestoreBackupResponse:
      type: object
      description: Response object for the restore backup request.
      required:
      - restoreCrn
      properties:
        restoreCrn:
          type: string
          description: The CRN of the restore.
    DescribeRestoreRequest:
      type: object
      description: Response object for the describe restore request.
      required:
      - restoreCrn
      properties:
        restoreCrn:
          type: string
          description: The unique CRN of the restore.
    ListBackupEntitiesResponse:
      type: object
      description: Response object for the list entities request.
      required:
      - items
      properties:
        items:
          type: array
          description: The list of potential candidates for backup. It should be a single entity that indicates the namespace which the control plane is running on.
          items:
            type: string
    JobState:
      type: string
      enum:
      - NOT_STARTED
      - IN_PROGRESS
      - COMPLETED
      - PARTIALLY_FAILED
      - FAILED
      - TERMINATING
      description: The current state of a Data Recovery Service job. The values are NOT_STARTED, IN_PROGRESS, COMPLETED, PARTIALLY_FAILED, FAILED and TERMINATING. NOT_STARTED indicates the job has not started. IN_PROGRESS indicates the job is running. COMPLETED indicates the job has finished running successfully. PARTIALLY_FAILED indicates the job has finished running with some warnings. FAILED indicates the job has finished running with errors and TERMINATING indicates that the entity containing this job is being deleted.
    ListRestoresRequest:
      type: object
      description: Request object for the list restores request.
      properties:
        jobStates:
          type: array
          items:
            $ref: '#/components/schemas/JobState'
          description: The job states to filter by.
        backupCrn:
          type: string
          description: CRN of the backup.
    DescribeBackupResponse:
      type: object
      description: Request object for the describe backup request.
      required:
      - backup
      properties:
        backup:
          $ref: '#/components/schemas/Backup'
          description: The backup details.
    ListBackupsResponse:
      type: object
      description: Response object for the list backups request.
      required:
      - backups
      properties:
        backups:
          type: array
          description: List of backups for the control plane.
          items:
            $ref: '#/components/schemas/SimpleBackup'
    Message:
      type: object
      description: The message object used to display warnings and errors during DRS workflows
      properties:
        text:
          type: string
          description: The text message of the warning/error.
        timestamp:
          type: string
          description: The time when the warning/error is hit.
        namespace:
          type: string
          description: The namespace that has the warning/error.
    ListBackupsRequest:
      type: object
      description: Request object for the list backups request.
      properties:
        backupName:
          type: string
          description: Specified name for the backup.
        jobStates:
          type: array
          items:
            $ref: '#/components/schemas/JobState'
          description: The job states to filter by.
    GetLogsRequest:
      type: object
      description: Request object for the get logs request.
      required:
      - crn
      properties:
        crn:
          type: string
          description: The CRN of the custom resource.
    DescribeRestoreResponse:
      type: object
      description: Response object for the describe restore request.
      required:
      - restore
      properties:
        restore:
          $ref: '#/components/schemas/Restore'
          description: The restore details.
    DeleteBackupRequest:
      type: object
      description: Request object for the delete backup request.
      required:
      - backupCrn
      properties:
        backupCrn:
          type: string
          description: The CRN of the backup.
    ListBackupEntitiesRequest:
      type: object
      description: Request object for the list entities request.
    DescribeBackupRequest:
      type: object
      description: Request object for the describe backup request.
      required:
      - backupCrn
      properties:
        backupCrn:
          type: string
          description: The CRN of the backup.
    CreateBackupRequest:
      type: object
      description: Request object for the create backup request.
      properties:
        backupName:
          type: string
          description: Specified name for the backup.
        itemName:
          type: string
          description: Name of the potential candidate for backup. It is optional in the case of control plane.
    SimpleRestore:
      type: object
      description: A simple Restore entry for listRestore Usage
      properties:
        restoreCrn:
          type: string
          description: The CRN of the restore.
        backupCrn:
          type: string
          description: The CRN of the backup.
        restoreCreationTime:
          type: string
          description: The time when the restore was created.
        includedNamespaces:
          type: array
          description: The list of namespaces to be included in restore.
          items:
            type: string
        restorePhase:
          type: string
          description: The phase of the restore operation. The values are PENDING, PRE_VALIDATION, STOPPING_APPS, DELETING_OBJECTS, DELETING_OBJECTS_PVC, RESTORING_PVC, RESTORING_OBJECTS, STARTING_APPS and FINISHED. PENDING indicates waiting for the job to start executing. PRE_VALIDATION indicates validation of the environment before restore. STOPPING_APPS indicates stopping the microservices before data restore. DELETING_OBJECTS indicates deletion of Kubernetes resources other than PersistentVolumeClaims. DELETING_OBJECTS_PVC indicates deletion of Kubernetes PersistentVolumeClaims. RESTORING_PVC indicates creation of Kubernetes PersistentVolumeClaims. RESTORING_OBJECTS indicates creating of Kubernetes objects other than PersistentVolumeClaims. STARTING_APPS indicates starting of the microservices after data restore and FINISHED indicates the restore job has finished.
        restoreJobState:
          type: string
          description: The current state of the restore job. The values are NOT_STARTED, IN_PROGRESS, COMPLETED, PARTIALLY_FAILED, FAILED and TERMINATING. NOT_STARTED indicates the job has not started. IN_PROGRESS indicates the job is running. COMPLETED indicates the job has finished running successfully. PARTIALLY_FAILED indicates the job has finished running with some warnings. FAILED indicates the job has finished running with errors and TERMINATING indicates that the entity containing this job is being deleted.
x-endpoint-name: drscp
x-products: CDP
x-form-factors: private
x-audit: true
x-cdp-releases: PUBLIC