Cloudera Docs

Navigating Cloudera Data Visualization API documentation

The Swagger interface is organized into collapsible sections based on resource categories. You can expand the category to view the endpoints it contains.

The API endpoints you can see in the documentation are determined by environment variables in Cloudera Data Visualization.

Admin API endpoints

  • groups
  • users
  • roles
  • segments
  • filterassociations
  • workspaces
  • datasets
  • visuals
  • connections

For instructions on how to enable Admin APIs, see Enabling Admin API support.

Non-admin API endpoints

  • /migration/api/import
  • /migration/api/export
  • /adminapi/edituserprofile/{username}
  • /adminapi/gcmonitor
  • /adminapi/gcstats
  • /adminapi/loglevel
  • /adminapi/loglevel/{logger_name}
  • /adminapi/toggle_cprofile
  • /datasets/dataset/cache_reset/{id}
  • /datasets/dataconnection/cache_reset/{id}
  • /jobs/api/run/
  • /jobs/api/extracts/run
  • /jobs/api/extracts/create

Non-admin APi endpoints are always enabled and shown.

Data API endpoints

  • /apps/dataapi
  • /api/data

The Data API is disabled application-wide by default. As a result, these endpoints are also disabled in Swagger and will not be visible in the documentation.

For instructions on how to enable Data APIs, see Enabling Data APIs.

API methods and details

Each section contains multiple API endpoints that support different HTTP methods:

  • GET – Retrieve information.
  • POST – Create new resources.
  • DELETE – Remove resources.

Expanding an endpoint provides detailed information, including:

  • Endpoint URL
  • Request method
  • Parameters
  • Request body
  • Responses
  • Code snippets

If authentication is configured, the interface also supports interactive API testing, allowing you to run requests directly from the documentation.