Overview

Applications is a web service for managing application lifecycle.

Version information

Version : 0.9.147 (BETA)

License information

License : Apache 2.0
Terms of service : https://www.cloudera.com/legal/commercial-terms-and-conditions.html

URI scheme

Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/json

Paths

Create Application

POST /api/v1/applications/createApplication

Description

Creates an application.

Parameters

Type Name Schema

Body

input
required

CreateApplicationRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

CreateApplicationResponse

default

The default response on an error.

Error

Delete Application

POST /api/v1/applications/deleteApplication

Description

Deletes an application.

Parameters

Type Name Schema

Body

input
required

DeleteApplicationRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DeleteApplicationResponse

default

The default response on an error.

Error

Describe Application

POST /api/v1/applications/describeApplication

Description

Describes an application.

Parameters

Type Name Schema

Body

input
required

DescribeApplicationRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DescribeApplicationResponse

default

The default response on an error.

Error

Get Application Metadata Configuration

POST /api/v1/applications/getApplicationMetadataConfiguration

Description

Retrieves the configuration schema and field definitions for a specific application type and version.

Parameters

Type Name Schema

Body

input
required

GetApplicationMetadataConfigurationRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

GetApplicationMetadataConfigurationResponse

default

The default response on an error.

Error

Lists Applications

POST /api/v1/applications/listApplications

Description

Provides a list of applications.

Parameters

Type Name Schema

Body

input
required

ListApplicationsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListApplicationsResponse

default

The default response on an error.

Error

Lists Applications Metadata

POST /api/v1/applications/listApplicationsMetadata

Description

Provides a list of applications metadata.

Parameters

Type Name Schema

Body

input
required

ListApplicationsMetadataRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListApplicationsMetadataResponse

default

The default response on an error.

Error

Lists available clusters

POST /api/v1/applications/listAvailableClusters

Description

Provides a list of available clusters.

Parameters

Type Name Schema

Body

input
required

ListAvailableClustersRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListAvailableClustersResponse

default

The default response on an error.

Error

Definitions

ApplicationHealthStatus

Health status of an Application. HEALTHY - Application is in a Healthy status. UNHEALTHY - Application is in an Unhealthy status. UNKNOWN - Application is in an Unknown status

Type : enum (HEALTHY, UNHEALTHY, UNKNOWN)

ApplicationInfo

Details of an application.

Name Description Schema

actualState
optional

The actual state of the application.

ApplicationState

applicationCrn
optional

The CRN of application.

string

applicationSpotPolicy
optional

Spot instance policy of an application.

ApplicationSpotPolicy

applicationVersion
optional

The version of the installed application.

string

clusterCrn
optional

The compute cluster used by the application.

string

clusterName
optional

The name of compute cluster used by the application.

string

desiredState
optional

The desired state of the application.

ApplicationState

endpoints
optional

Application endpoint URL.

< Endpoint > array

environmentCrn
optional

The Environment CRN for the application.

string

environmentName
optional

The Environment name for the application.

string

name
optional

The name of application.

string

size
optional

The size of the application refers to the specific amount of resources, such as CPU, memory, GPU and storage, that are allocated and guaranteed for that instance. Example Values: TINY,SMALL, LARGE, XLARGE, etc

string

status
optional

The health status of the application.

ApplicationHealthStatus

tags
optional

Tags to added to the cloud provider resources created.

< string, string > map

type
optional

The type of application.

ApplicationType

ApplicationMetadata

Application metadata details of an application that can be installed.

Name Description Schema

description
optional

the description of the application.

string

displayName
optional

the display name of the application.

string

status
optional

Describes the overall application maturity and availability. E.g. "LIMITED_SUPPORT", "GA_SUPPORT", "DEPRECATED", "IN_DEVELOPMENT"

string

summary
optional

the summary of the application.

string

tags
optional

Arbitrary list of identifying tags. Can be used for search in the future.

< string > array

type
optional

the type of the application.

string

versions
optional

List of app versions that can be installed.

< ApplicationMetadataVersion > array

ApplicationMetadataVersion

Application metadata for available versions of applications.

Name Description Schema

buildNum
optional

The build number of the application.

string

description
optional

The application description for this version.

string

sizes
optional

The available sizes for instance group creation.

< string > array

status
optional

Status describes the overall application maturity and availability for this specific release version. E.g. "LIMITED_SUPPORT", "GA_SUPPORT", "DEPRECATED", "IN_DEVELOPMENT"

string

version
optional

The version of the application.

string

ApplicationSpotPolicy

Application policy for using spot tier in public cloud DEFAULT - By default application infra services and workload master would run on on-demand instances and the application workload executor will run on spot instances. WORKLOAD - WORKLOAD will run all application workloads including workload master (driver) on spot instamces. NONE - NONE will run all application services on on-demand instances. ALL - ALL will run all application services on spot instances.

Type : enum (DEFAULT, WORKLOAD, NONE)

ApplicationState

Health state of an Application. INFRA_PROVISIONING - Application is provisioning and configuring required infra. INFRA_PROVISIONED - Underlying infra has been provisioned and configured. INFRA_PROVISIONING_FAILED - Underlying infra has been provisioned and configured. STARTING - Application is starting. STARTED - Application has started. STARTING_FAILED - Application starting failed. STOPPING - Application is stopping. STOPPED - Application is stopped. STOPPING_FAILED - Application stopping failed. DELETING - Application is being deleted. DELETED - Application is deleted. DELETING_FAILED - Application deleting failed.

Type : enum (INFRA_PROVISIONING, INFRA_PROVISIONED, INFRA_PROVISIONING_FAILED, STARTING, STARTED, STARTING_FAILED, STOPPING, STOPPED, STOPPING_FAILED, DELETING, DELETED, DELETING_FAILED)

ApplicationType

CDP Application Type. AIRFLOW - Airflow CSS - Cloudera Semantic Search NOTEBOOK - Standalone Notebook Service RAY - Standalone Ray Service HTTPBIN - HTTPBin Service

Type : enum (AIRFLOW, CSS)

CloudProviderType

Cloud Provider Type. AWS - AWS cloud provider AZURE - AZURE cloud provider GCP - GCP cloud provider

Type : enum (AWS)

ClusterInfo

Cluster information for an application.

Name Description Schema

cloudProvider
optional

The cloud provider of the cluster, e.g. "AWS", "AZURE", "GCP".

string

clusterCrn
optional

The CRN of the cluster.

string

environmentName
optional

The environment name.

string

name
optional

The name of the cluster.

string

statusMessage
optional

The status of the cluster.

ClusterStatusMessage

ClusterStatusMessage

Cluster status message detail.

Name Description Schema

message
optional

The status message. Typically an error message.

string

platformMessageDetails
optional

The cloud provider details.

PlatformMessageDetails

status
optional

The status. e.g. "RUNNING", "CREATING".

string

CreateApplicationRequest

Request object for the CreateApplication method.

Name Description Schema

applicationSpotPolicy
optional

By default application infra services would run on on-demand instances and the application workloads on spot instances. Setting this config to ALL will run all application services on spot instances. Setting it to NONE will run all application services on on-demand instances.

ApplicationSpotPolicy

applicationVersion
optional

The version of the application to be installed. If not specified, latest supported version for the application will be used.

string

clusterCrn
optional

The CRN of the cluster in which application should be created. If not specified, default environment cluster wil be used.

string

configOverrides
optional

A map of configOverrides to put in custom configurations. There will be a list all configurations feature in the future.

< string, string > map

dbType
optional

Which DB type (external/embedded) to request for the app if it supports a DB. If not used, will default to what’s in the appspec.

DatabaseType

environment
required

The name or CRN of the environment in which application should be created.

string

name
required

The application name.

string

size
optional

The size of the application refers to the specific amount of resources, such as CPU, memory, GPU and storage, that are allocated and guaranteed for that instance. Example Values: TINY,SMALL, LARGE, XLARGE, etc

string

skipValidation
optional

Skip pre-flight validations if requested.
Default : false

boolean

tags
optional

Tags to add to the cloud provider resources created.

< string, string > map

type
required

The type of application.

ApplicationType

CreateApplicationResponse

Response object for the CreateApplication method.

Name Description Schema

application
optional

The details of the application.

ApplicationInfo

requestId
optional

The request id to track the progress of the create operation.

integer (int64)

DatabaseType

Application Database Type. EMBEDDED - Embedded Database EXTERNAL - External Database

Type : enum (EMBEDDED, EXTERNAL)

DeleteApplicationRequest

Request object for the DeleteApplication method.

Name Description Schema

application
required

The name or CRN of the application.

string

environment
required

The name or CRN of the environment.

string

force
optional

Force deletion enabled.

boolean

DeleteApplicationResponse

Response object for the DeleteApplication method.

Name Description Schema

application
optional

The details of the application.

ApplicationInfo

requestId
optional

The request id to track the progress of the delete operation.

integer (int64)

DescribeApplicationRequest

Request object for the DescribeApplication method.

Name Description Schema

application
required

The name or CRN of the pplication.

string

environment
required

The name or CRN of the environment.

string

DescribeApplicationResponse

Response object for the DescribeApplication method.

Name Description Schema

application
optional

The details of the application.

ApplicationInfo

Endpoint

Endpoint details for an application. Can contain UI endpoints, API endpoints, etc.

Name Description Schema

description
optional

The description of the endpoint.

string

endpointType
optional

The type of the endpoint. eg. UI, API.

EndpointType

name
optional

The Name of the Url.

string

serviceUrl
optional

The endpoint URL for the application.

string

EndpointType

Endpoint Type. UI - UI endpoint API - API endpoint

Type : enum (UI, API)

Error

An object returned on an error.

Name Description Schema

code
optional

The error code.

string

message
optional

The error message.

string

FieldDefinition

Structure, validation, and UI behavior for configurable application parameters.

Name Description Schema

default
optional

The default value for the field.

string

description
optional

The description of the field.

string

enum
optional

The enum options for the field.

< string > array

maximum
optional

The maximum value for the field.

integer (int64)

minimum
optional

The minimum value for the field.

integer (int64)

pattern
optional

The regex validation pattern for the field.

string

placeholder
optional

The placeholder text for the field.

string

properties
optional

The nested properties for object-type fields.

< Property > array

required
optional

Whether the field is required.

boolean

title
required

The display title of the field shown to users in forms or UI.

string

type
required

The type of the field (string, integer, boolean, object).

string

ui
optional

UI-specific hints for how a client should render the field.

UiHints

GetApplicationMetadataConfigurationRequest

Request object for the GetApplicationMetadataConfiguration method.

Name Description Schema

applicationVersion
required

The specific version of the application to retrieve configuration for.

string

size
optional

The deployment size tier for the application, which affects available configuration options. Example Values: TINY,SMALL, LARGE, XLARGE, etc

string

type
required

The type of application for which to retrieve configuration metadata.

ApplicationType

GetApplicationMetadataConfigurationResponse

Response object for the GetApplicationMetadataConfiguration method.

Name Description Schema

properties
optional

Configuration properties describing the structure and validation rules for each configurable parameter.

< Property > array

title
optional

The display title for the configuration form or schema.

string

ListApplicationsMetadataRequest

Request object for the ListApplicationsMetadata method.

Name Description Schema

cloudProvider
optional

Cloud provider platform.

CloudProviderType

pageSize
optional

The page size.
Minimum value : 5
Maximum value : 20

integer (int32)

pageToken
optional

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

string

ListApplicationsMetadataResponse

Response object for the ListApplicationsMetadata method.

Name Description Schema

applicationsMetadata
optional

A detailed list of installable applications

< ApplicationMetadata > array

nextPageToken
optional

The token to use when requesting the next set of results. If not present, there are no additional results.

string

ListApplicationsRequest

Request object for the ListApplications method.

Name Description Schema

environment
optional

The name or CRN of the environment. If omitted, the API will return all applications across environments that are accessible to the requesting user.

string

pageSize
optional

The page size.
Minimum value : 5
Maximum value : 20

integer (int32)

pageToken
optional

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

string

ListApplicationsResponse

Response object for the ListApplications method.

Name Description Schema

applications
optional

A detailed list of applications within the environment.

< ApplicationInfo > array

nextPageToken
optional

The token to use when requesting the next set of results. If not present, there are no additional results.

string

ListAvailableClustersRequest

Request object for the ListAvailableClusters method.

Name Description Schema

applicationVersion
optional

The version of the application.

string

environment
required

The name or CRN of the environment to list clusters for.

string

pageSize
optional

The page size.
Minimum value : 5
Maximum value : 20

integer (int32)

pageToken
optional

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

string

type
optional

The type of application.

ApplicationType

ListAvailableClustersResponse

Response object for the ListAvailableClusters method.

Name Description Schema

clusters
optional

A detailed list of available clusters in the environment.

< ClusterInfo > array

nextPageToken
optional

The token to use when requesting the next set of results. If not present, there are no additional results.

string

PlatformMessageDetails

Platform message details for a cluster status message.

Name Description Schema

errorMessage
optional

Error message from the cloud provider.

string

Property

Represents a key-value property pair.

Name Description Schema

key
required

The property name/key.

string

value
required

The field definition for this property.

FieldDefinition

UiHints

UI-specific hints for how a client should render the field.

Name Description Schema

isEditable
optional

Whether this field can be edited after initial configuration or installation.

boolean

isVisibleDuringInstallation
optional

Whether this field should be visible and configurable during application installation.

boolean

sensitive
optional

Whether this field contains sensitive data that should be masked or hidden in UI.

boolean

Copyright © 2025 Cloudera, Inc. All rights reserved.