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

Cloudera Image Catalog API

Manage the custom VM image catalogs that datalake and Data Hub provisioning draws from. 11 operations.

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

Tagged areas include Images, Catalog, and Provisioning. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 11 operations across 11 paths, and defines 29 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.

11 operations 11 paths 29 schemas 11 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
Resource Areas
1

Paths & Operations 11

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

Operations 11
POST
/api/v1/imagecatalog/createCustomCatalog
Create custom image catalog
createCustomCatalog 1 param → 200default
POST
/api/v1/imagecatalog/deleteCustomCatalog
Delete custom image catalog
deleteCustomCatalog 1 param → 200default
POST
/api/v1/imagecatalog/deleteFreeipaImage
Delete FreeIPA image
deleteFreeipaImage 1 param → 200default
POST
/api/v1/imagecatalog/deleteRuntimeImage
Delete Cloudera Runtime image
deleteRuntimeImage 1 param → 200default
POST
/api/v1/imagecatalog/describeCustomCatalog
Describe custom image catalog
describeCustomCatalog 1 param → 200default
POST
/api/v1/imagecatalog/describeCustomImage
Describe custom image
describeCustomImage 1 param → 200default
POST
/api/v1/imagecatalog/describeDefaultImage
Describe default image
describeDefaultImage 1 param → 200default
POST
/api/v1/imagecatalog/findDefaultImage
Find default image
findDefaultImage 1 param → 200default
POST
/api/v1/imagecatalog/listCustomCatalogs
List custom image catalogs
listCustomCatalogs 1 param → 200default
POST
/api/v1/imagecatalog/setFreeipaImage
Add or update FreeIPA image
setFreeipaImage 1 param → 200default
POST
/api/v1/imagecatalog/setRuntimeImage
Add or update Cloudera Runtime image
setRuntimeImage 1 param → 200default

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are DescribeCustomImageResponse (9 properties), ImageItemResponse (7 properties), SetRuntimeImageRequest (5 properties), SetFreeipaImageRequest (5 properties). Each schema is shown below with its type and property counts.

Error
object
An object returned on an error.
2 properties
CreateCustomCatalogRequest
object
The request object to create a custom image catalog.
2 properties 1 required
CreateCustomCatalogResponse
object
The response object returned in case the custom image catalog has been successfully created.
DeleteCustomCatalogRequest
object
The request object to delete a custom image catalog.
1 property 1 required
DeleteCustomCatalogResponse
object
The response object returned in case of successful custom image catalog deletion.
ListCustomCatalogsRequest
object
The request object to list the registered custom image catalogs.
ListCustomCatalogsResponse
object
The response object for the list of registered image catalogs.
1 property
CustomImageCatalog
object
Basic image catalog data.
2 properties
DescribeCustomCatalogRequest
object
The request object to retrieve data about a custom catalog.
1 property 1 required
DescribeCustomCatalogResponse
object
The response object holding the retrieved data of a custom catalog.
3 properties
SetRuntimeImageRequest
object
The request object to add or update a Cloudera Runtime image in a catalog.
5 properties 3 required
SetFreeipaImageRequest
object
The request object to add or update a FreeIPA image in a catalog.
5 properties 3 required
VmImageRequest
object
Model holding information about a custom VM image and the cloud region it belongs to. The format of the image reference is specific to the cloud provider, e.g.…
2 properties 2 required
SetRuntimeImageResponse
object
The response object holding data about the added or updated Cloudera Runtime image.
1 property
SetFreeipaImageResponse
object
The response object holding data about the added or updated FreeIPA image.
1 property
DeleteRuntimeImageRequest
object
The request object to delete Cloudera Runtime image from a catalog.
2 properties 2 required
DeleteFreeipaImageRequest
object
The request object to delete FreeIPA image from a catalog.
2 properties 2 required
DeleteRuntimeImageResponse
object
The response object returned in case the Cloudera Runtime image has been successfully removed from the catalog.
1 property
DeleteFreeipaImageResponse
object
The response object returned in case the FreeIPA image has been successfully removed from the catalog.
1 property
DescribeCustomImageRequest
object
The request object to retrieve data of an image from the given catalog.
2 properties 2 required
DescribeCustomImageResponse
object
The response object holding the data of the image retrieved from the given custom catalog.
9 properties
VmImageProvider
string
Object representing a valid cloud provider name. AWS - The image is an AWS VM image AZURE - The image is an Azure VM image GCP - The image is a GCP VM image
VmImageType
string
Object representing a valid VM image type. FREEIPA - FreeIPA image RUNTIME - Cloudera Runtime image
FindDefaultImageRequest
object
The request object to filter data that is used for retrieving an image from the default image catalog.
4 properties 2 required
FindDefaultImageResponse
object
The response object for holding data about an image retrieved from the default image catalog.
2 properties
DescribeDefaultImageRequest
object
The request object to retrieve an image from the default image catalog.
1 property 1 required
DescribeDefaultImageResponse
object
The response object for holding data about an image retrieved from the default image catalog.
2 properties
VmImageResponse
object
Model holding information about a custom VM image and the cloud region it belongs to. The format of the image reference is specific to the cloud provider, e.g.…
2 properties
ImageItemResponse
object
Model holding detailed information about a custom VM image.
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudera-imagecatalog-openapi.yml Raw ↑

Other APIs Cloudera publishes across the network.

Cloudera Audit Service API
Cloudera Private Links API
Cloudera Compute Service API
Cloudera Consumption API
Cloudera Data Catalog API
Cloudera Data Hub API
Cloudera Datalake API
Cloudera Data Engineering API
Cloudera DataFlow API
Cloudera DataFlow Workload API
Cloudera Control Plane Data Recovery API
Cloudera Data Warehouse API
Where this information came from

This is an independent, third-party profile of Cloudera Image Catalog 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.