Cloudera

Cloudera Imagecatalog API

The Imagecatalog API from Cloudera — 11 operation(s) for imagecatalog.

GitHub OpenAPI

Operations 11

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/imagecatalog/createCustomCatalog Create a custom image catalog · Create custom image catalog #
Ask an LLM
“How do I set up my own image catalog for Cloudera Runtime and FreeIPA images?”
“Can I add a description when I create a new custom image catalog?”
Tell an agent
Create a custom image catalog named {catalogName}.
Create image catalog {catalogName} with the description {description}.
POST /api/v1/imagecatalog/deleteCustomCatalog Delete a custom image catalog · Delete custom image catalog #
Ask an LLM
“Can I remove a custom image catalog I no longer use?”
“What happens to an entire custom image catalog when I delete it?”
Tell an agent destructive · confirm first
Delete the custom image catalog {catalogName}.
Remove image catalog {catalogName} entirely.
POST /api/v1/imagecatalog/deleteFreeipaImage Delete a FreeIPA image from a catalog · Delete FreeIPA image #
Ask an LLM
“How do I take a FreeIPA image out of one of my custom catalogs?”
“Can I delete a single FreeIPA image without deleting the whole catalog?”
Tell an agent destructive · confirm first
Delete FreeIPA image {imageId} from catalog {catalogName}.
Remove the FreeIPA image {imageId} from my {catalogName} image catalog.
POST /api/v1/imagecatalog/deleteRuntimeImage Delete a Cloudera Runtime image from a catalog · Delete Cloudera Runtime image #
Ask an LLM
“Can I remove an outdated Cloudera Runtime image from my custom catalog?”
“Which details do I need to delete a Runtime image from a catalog?”
Tell an agent destructive · confirm first
Delete Cloudera Runtime image {imageId} from catalog {catalogName}.
Remove the Runtime image {imageId} from the {catalogName} catalog.
POST /api/v1/imagecatalog/describeCustomCatalog Get details of a custom image catalog · Describe custom image catalog #
Ask an LLM
“What images and settings does my custom image catalog contain?”
“Can I look up the details of one specific custom image catalog by name?”
Tell an agent
Describe the custom image catalog {catalogName}.
Show me what is in image catalog {catalogName}.
POST /api/v1/imagecatalog/describeCustomImage Get details of an image in a custom catalog · Describe custom image #
Ask an LLM
“What do I know about a specific image stored in my custom catalog?”
“Can I inspect one image inside a custom image catalog by its id?”
Tell an agent
Describe image {imageId} in custom catalog {catalogName}.
Show the details of image {imageId} from my {catalogName} catalog.
POST /api/v1/imagecatalog/describeDefaultImage Get an image from the default catalog by id · Describe default image #
Ask an LLM
“How do I look up an image in Cloudera's default catalog when I already know its id?”
“Can I fetch a default-catalog image directly without naming a catalog?”
Tell an agent
Describe default catalog image {imageId}.
Get image {imageId} straight from the default image catalog.
POST /api/v1/imagecatalog/findDefaultImage Find a default image by provider and type · Find default image #
Ask an LLM
“Which default image should I use for a given cloud provider and image type?”
“Can I filter the default catalog by runtime version or CPU architecture to find an image?”
Tell an agent
Find the default {imageType} image for cloud provider {provider}.
Find a default {imageType} image on {provider} for runtime {runtimeVersion} and {architecture} architecture.
POST /api/v1/imagecatalog/listCustomCatalogs List custom image catalogs · List custom image catalogs #
Ask an LLM
“Which custom image catalogs can I access?”
“What Runtime and FreeIPA image catalogs exist in my account?”
Tell an agent
List all my custom image catalogs.
Show every Runtime and FreeIPA image catalog I have access to.
POST /api/v1/imagecatalog/setFreeipaImage Add or update a FreeIPA image in a catalog · Add or update FreeIPA image #
Ask an LLM
“How do I add a FreeIPA image to my custom catalog?”
“Can I update an existing FreeIPA image entry with new VM images?”
Tell an agent
Add FreeIPA image based on {sourceImageId} with VM images {vmImages} to catalog {catalogName}.
Update FreeIPA image {imageId} in catalog {catalogName} from source {sourceImageId} using VM images {vmImages}.
POST /api/v1/imagecatalog/setRuntimeImage Add or update a Cloudera Runtime image · Add or update Cloudera Runtime image #
Ask an LLM
“Can I add a Cloudera Runtime image to my own catalog?”
“Is it possible to point a Runtime image at a different base parcel URL?”
Tell an agent
Add a Cloudera Runtime image from source {sourceImageId} with VM images {vmImages} to catalog {catalogName}.
Update Runtime image {imageId} in {catalogName} from {sourceImageId} with VM images {vmImages} and base parcel URL {baseParcelUrl}.

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

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-describe-custom-image-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-find-default-image-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-set-runtime-image-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-set-freeipa-image-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-describe-custom-catalog-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/json-schema/cloudera-describe-default-image-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-imagecatalog-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-imagecatalog-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 0.9.163
  title: Image catalog service Imagecatalog API
  license:
    name: Apache 2.0
  description: Service for managing custom image catalogs and their associated Cloudera Runtime and FreeIPA images.
  termsOfService: https://www.cloudera.com/legal/commercial-terms-and-conditions.html
tags:
- name: Imagecatalog
paths:
  /api/v1/imagecatalog/createCustomCatalog:
    post:
      summary: Create custom image catalog
      description: Creates a new image catalog for Cloudera Runtime and FreeIPA images.
      operationId: createCustomCatalog
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCustomCatalogResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomCatalogRequest'
        required: true
      tags:
      - Imagecatalog
  /api/v1/imagecatalog/deleteCustomCatalog:
    post:
      summary: Delete custom image catalog
      description: Deletes an existing image catalog.
      operationId: deleteCustomCatalog
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCustomCatalogResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteCustomCatalogRequest'
        required: true
      tags:
      - Imagecatalog
  /api/v1/imagecatalog/deleteFreeipaImage:
    post:
      summary: Delete FreeIPA image
      description: Deletes a FreeIPA image from a given catalog.
      operationId: deleteFreeipaImage
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteFreeipaImageResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteFreeipaImageRequest'
        required: true
      tags:
      - Imagecatalog
  /api/v1/imagecatalog/deleteRuntimeImage:
    post:
      summary: Delete Cloudera Runtime image
      description: Deletes a Cloudera Runtime image from a given catalog.
      operationId: deleteRuntimeImage
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteRuntimeImageResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteRuntimeImageRequest'
        required: true
      tags:
      - Imagecatalog
  /api/v1/imagecatalog/describeCustomCatalog:
    post:
      summary: Describe custom image catalog
      description: Retrieves data about an existing image catalog.
      operationId: describeCustomCatalog
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeCustomCatalogResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeCustomCatalogRequest'
        required: true
      tags:
      - Imagecatalog
  /api/v1/imagecatalog/describeCustomImage:
    post:
      summary: Describe custom image
      description: Retrieves data about a specific image from a given catalog.
      operationId: describeCustomImage
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeCustomImageResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeCustomImageRequest'
        required: true
      tags:
      - Imagecatalog
  /api/v1/imagecatalog/describeDefaultImage:
    post:
      summary: Describe default image
      description: Retrieves an image directly by id from the default catalog.
      operationId: describeDefaultImage
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeDefaultImageResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeDefaultImageRequest'
        required: true
      tags:
      - Imagecatalog
  /api/v1/imagecatalog/findDefaultImage:
    post:
      summary: Find default image
      description: Retrieves an image based on the filters from the default catalog.
      operationId: findDefaultImage
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FindDefaultImageResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FindDefaultImageRequest'
        required: true
      tags:
      - Imagecatalog
  /api/v1/imagecatalog/listCustomCatalogs:
    post:
      summary: List custom image catalogs
      description: Lists all the Cloudera Runtime/FreeIPA image catalogs accessible for the user.
      operationId: listCustomCatalogs
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCustomCatalogsResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListCustomCatalogsRequest'
        required: true
      tags:
      - Imagecatalog
  /api/v1/imagecatalog/setFreeipaImage:
    post:
      summary: Add or update FreeIPA image
      description: Adds or updates a FreeIPA image in the catalog.
      operationId: setFreeipaImage
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetFreeipaImageResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetFreeipaImageRequest'
        required: true
      tags:
      - Imagecatalog
  /api/v1/imagecatalog/setRuntimeImage:
    post:
      summary: Add or update Cloudera Runtime image
      description: Adds or updates a Cloudera Runtime image in the catalog.
      operationId: setRuntimeImage
      responses:
        200:
          description: Expected response to a valid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetRuntimeImageResponse'
        default:
          description: The default response on an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-mutating: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetRuntimeImageRequest'
        required: true
      tags:
      - Imagecatalog
components:
  schemas:
    VmImageType:
      type: string
      description: "Object representing a valid VM image type.\n `FREEIPA` - FreeIPA image `RUNTIME` - Cloudera Runtime image"
      enum:
      - FREEIPA
      - RUNTIME
    VmImageResponse:
      type: object
      description: 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. URL in case of Azure, AMI ID in case of AWS.
      properties:
        region:
          type: string
          description: Region
        imageReference:
          type: string
          description: Image reference
    DescribeDefaultImageResponse:
      type: object
      description: The response object for holding data about an image retrieved from the default image catalog.
      properties:
        imageId:
          type: string
          description: Image UUID
        vmImages:
          type: array
          items:
            $ref: '#/components/schemas/VmImageResponse'
          description: List of images
    CustomImageCatalog:
      type: object
      description: Basic image catalog data.
      properties:
        name:
          type: string
          description: Image catalog name
        description:
          type: string
          description: Image catalog description
    ImageItemResponse:
      type: object
      description: Model holding detailed information about a custom VM image.
      properties:
        imageId:
          type: string
          description: Image UUID
        imageDate:
          type: integer
          format: int64
          description: Image creation date
        imageType:
          description: Image type - either "FREEIPA" or "RUNTIME"
          $ref: '#/components/schemas/VmImageType'
        sourceImageId:
          type: string
          description: Customized image UUID
        sourceImageDate:
          type: integer
          format: int64
          description: Customized image creation date
        versions:
          type: object
          description: Package versions
          additionalProperties:
            type: string
        provider:
          description: Cloud provider - either AWS, AZURE or GCP
          $ref: '#/components/schemas/VmImageProvider'
    VmImageProvider:
      type: string
      description: "Object representing a valid cloud provider name.\n `AWS` - The image is an AWS VM image `AZURE` - The image is an Azure VM image `GCP` - The image is a GCP VM image"
      enum:
      - AWS
      - AZURE
      - GCP
    SetRuntimeImageRequest:
      type: object
      description: The request object to add or update a Cloudera Runtime image in a catalog.
      required:
      - catalogName
      - sourceImageId
      - vmImages
      properties:
        catalogName:
          type: string
          description: Image catalog name
        sourceImageId:
          type: string
          description: UUID of the image customized by the current image
        vmImages:
          type: array
          items:
            $ref: '#/components/schemas/VmImageRequest'
          description: List of images
        imageId:
          type: string
          description: Image UUID. If this is empty, a randomly generated UUID is used
        baseParcelUrl:
          type: string
          description: Base parcel URL
          x-no-paramfile: true
    VmImageRequest:
      type: object
      description: 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. URL in case of Azure, AMI ID in case of AWS.
      required:
      - region
      - imageReference
      properties:
        region:
          type: string
          description: Region
        imageReference:
          type: string
          description: Image reference
          x-no-paramfile: true
    ListCustomCatalogsResponse:
      type: object
      description: The response object for the list of registered image catalogs.
      properties:
        imageCatalogs:
          type: array
          items:
            $ref: '#/components/schemas/CustomImageCatalog'
          description: The list of registered image catalogs
    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.
    CreateCustomCatalogRequest:
      type: object
      description: The request object to create a custom image catalog.
      required:
      - catalogName
      properties:
        catalogName:
          type: string
          description: Image catalog name
        description:
          type: string
          description: Image catalog description
    SetFreeipaImageRequest:
      type: object
      description: The request object to add or update a FreeIPA image in a catalog.
      required:
      - catalogName
      - sourceImageId
      - vmImages
      properties:
        catalogName:
          type: string
          description: Image catalog name
        sourceImageId:
          type: string
          description: UUID of the image customized by the current image
        vmImages:
          type: array
          items:
            $ref: '#/components/schemas/VmImageRequest'
          description: List of images
        imageId:
          type: string
          description: Image UUID. If this is empty, a randomly generated UUID is used
        baseParcelUrl:
          type: string
          description: Base parcel URL
          x-no-paramfile: true
    DescribeDefaultImageRequest:
      type: object
      description: The request object to retrieve an image from the default image catalog.
      required:
      - imageId
      properties:
        imageId:
          type: string
          description: Image UUID
    FindDefaultImageResponse:
      type: object
      description: The response object for holding data about an image retrieved from the default image catalog.
      properties:
        imageId:
          type: string
          description: Image UUID
        vmImages:
          type: array
          items:
            $ref: '#/components/schemas/VmImageResponse'
          description: List of images
    DeleteCustomCatalogResponse:
      type: object
      description: The response object returned in case of successful custom image catalog deletion.
    DeleteCustomCatalogRequest:
      type: object
      description: The request object to delete a custom image catalog.
      required:
      - catalogName
      properties:
        catalogName:
          type: string
          description: Image catalog name
    DeleteRuntimeImageResponse:
      type: object
      description: The response object returned in case the Cloudera Runtime image has been successfully removed from the catalog.
      properties:
        imageId:
          type: string
          description: Image UUID
    DescribeCustomImageRequest:
      type: object
      description: The request object to retrieve data of an image from the given catalog.
      required:
      - catalogName
      - imageId
      properties:
        catalogName:
          type: string
          description: Image catalog name
        imageId:
          type: string
          description: Image UUID
    DescribeCustomImageResponse:
      type: object
      description: The response object holding the data of the image retrieved from the given custom catalog.
      properties:
        imageId:
          type: string
          description: Image UUID
        imageDate:
          type: integer
          format: int64
          description: Image creation date
        imageType:
          description: Image type - either "FREEIPA" or "RUNTIME"
          $ref: '#/components/schemas/VmImageType'
        sourceImageId:
          type: string
          description: Customized image UUID
        sourceImageDate:
          type: integer
          format: int64
          description: Customized image creation date
        versions:
          type: object
          description: Package versions
          additionalProperties:
            type: string
        provider:
          description: Cloud provider - either AWS, AZURE or GCP
          $ref: '#/components/schemas/VmImageProvider'
        baseParcelUrl:
          type: string
          description: Base parcel URL
        vmImages:
          type: array
          items:
            $ref: '#/components/schemas/VmImageResponse'
          description: List of images
    DescribeCustomCatalogResponse:
      type: object
      description: The response object holding the retrieved data of a custom catalog.
      properties:
        catalogName:
          type: string
          description: Image catalog name
        description:
          type: string
          description: Image catalog description
        images:
          type: array
          items:
            $ref: '#/components/schemas/ImageItemResponse'
          description: Detailed information of the images contained within
    SetRuntimeImageResponse:
      type: object
      description: The response object holding data about the added or updated Cloudera Runtime image.
      properties:
        imageId:
          type: string
          description: Image UUID
    DeleteFreeipaImageRequest:
      type: object
      description: The request object to delete FreeIPA image from a catalog.
      required:
      - catalogName
      - imageId
      properties:
        catalogName:
          type: string
          description: Image catalog name
        imageId:
          type: string
          description: Image UUID
    ListCustomCatalogsRequest:
      type: object
      description: The request object to list the registered custom image catalogs.
    DescribeCustomCatalogRequest:
      type: object
      description: The request object to retrieve data about a custom catalog.
      required:
      - catalogName
      properties:
        catalogName:
          type: string
          description: Image catalog name
    CreateCustomCatalogResponse:
      type: object
      description: The response object returned in case the custom image catalog has been successfully created.
    DeleteRuntimeImageRequest:
      type: object
      description: The request object to delete Cloudera Runtime image from a catalog.
      required:
      - catalogName
      - imageId
      properties:
        catalogName:
          type: string
          description: Image catalog name
        imageId:
          type: string
          description: Image UUID
    FindDefaultImageRequest:
      type: object
      description: The request object to filter data that is used for retrieving an image from the default image catalog.
      required:
      - provider
      - imageType
      properties:
        provider:
          description: Cloud provider - either AWS, AZURE or GCP
          $ref: '#/components/schemas/VmImageProvider'
        imageType:
          description: Image type - either "FREEIPA" or "RUNTIME"
          $ref: '#/components/schemas/VmImageType'
        runtimeVersion:
          type: string
          description: Cloudera runtime version
        architecture:
          type: string
          default: X86_64
          description: Specifies the CPU architecture. Values are ARM64, X86_64. Default is X86_64.
          enum:
          - ARM64
          - X86_64
    SetFreeipaImageResponse:
      type: object
      description: The response object holding data about the added or updated FreeIPA image.
      properties:
        imageId:
          type: string
          description: Image UUID
    DeleteFreeipaImageResponse:
      type: object
      description: The response object returned in case the FreeIPA image has been successfully removed from the catalog.
      properties:
        imageId:
          type: string
          description: Image UUID
x-generated: Automatically generated by CDP protoc plugin. Do not edit manually.
x-endpoint-name: imagecatalog
x-products: CDP
x-form-factors: public
x-cdp-releases: PUBLIC
x-audit: true