Application Catalog API

Primary API

Download the App Catalog API in OpenAPI YAML format

GET /v3/projects/{projectName}/catalog/applications

ListApplications

Gets a list of applications.

Parameters:

• projectName (string) – unique projectName for the resource

Query Parameters:

• orderBy (string) – Names the field to be used for ordering the returned results.

• filter (string) – Expression to use for filtering the results.

• pageSize (integer) – Maximum number of items to return.

• offset (integer) – Index of the first item to return.

• kinds (array) – List of application kinds to be returned; empty list means all kinds.

Status Codes:

• 200 OK – OK

POST /v3/projects/{projectName}/catalog/applications

CreateApplication

Creates a new application.

Parameters:

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

GET /v3/projects/{projectName}/catalog/applications/{applicationName}/versions

GetApplicationVersions

Gets all versions of a named application.

Parameters:

• applicationName (string) – Name of the application.

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

DELETE /v3/projects/{projectName}/catalog/applications/{applicationName}/versions/{version}

DeleteApplication

Deletes an application.

Parameters:

• applicationName (string) – Name of the application.

• version (string) – Version of the application.

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

GET /v3/projects/{projectName}/catalog/applications/{applicationName}/versions/{version}

GetApplication

Gets a specific application.

Parameters:

• applicationName (string) – Name of the application.

• version (string) – Version of the application.

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

PUT /v3/projects/{projectName}/catalog/applications/{applicationName}/versions/{version}

UpdateApplication

Updates an application.

Parameters:

• applicationName (string) – Name of the application.

• version (string) – Version of the application.

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

GET /v3/projects/{projectName}/catalog/applications/{applicationName}/versions/{version}/reference_count

GetApplicationReferenceCount

Gets application reference count - the number of deployment packages using this application.

Parameters:

• applicationName (string) – Name of the application.

• version (string) – Version of the application.

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

GET /v3/projects/{projectName}/catalog/artifacts

ListArtifacts

Gets a list of artifacts.

Parameters:

• projectName (string) – unique projectName for the resource

Query Parameters:

• orderBy (string) – Names the field to be used for ordering the returned results.

• filter (string) – Expression to use for filtering the results.

• pageSize (integer) – Maximum number of items to return.

• offset (integer) – Index of the first item to return.

Status Codes:

• 200 OK – OK

POST /v3/projects/{projectName}/catalog/artifacts

CreateArtifact

Creates a new artifact.

Parameters:

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

DELETE /v3/projects/{projectName}/catalog/artifacts/{artifactName}

DeleteArtifact

Deletes an artifact.

Parameters:

• artifactName (string) – Name of the artifact.

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

GET /v3/projects/{projectName}/catalog/artifacts/{artifactName}

GetArtifact

Gets a specific artifact.

Parameters:

• artifactName (string) – Name of the artifact.

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

PUT /v3/projects/{projectName}/catalog/artifacts/{artifactName}

UpdateArtifact

Updates an artifact.

Parameters:

• artifactName (string) – Name of the artifact.

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

GET /v3/projects/{projectName}/catalog/deployment_packages

ListDeploymentPackages

Gets a list of deployment packages.

Parameters:

• projectName (string) – unique projectName for the resource

Query Parameters:

• orderBy (string) – Names the field to be used for ordering the returned results.

• filter (string) – Expression to use for filtering the results.

• pageSize (integer) – Maximum number of items to return.

• offset (integer) – Index of the first item to return.

• kinds (array) – List of deployment package kinds to be returned; empty list means all kinds.

Status Codes:

• 200 OK – OK

POST /v3/projects/{projectName}/catalog/deployment_packages

CreateDeploymentPackage

Creates a new deployment package.

Parameters:

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

GET /v3/projects/{projectName}/catalog/deployment_packages/{deploymentPackageName}/versions

GetDeploymentPackageVersions

Gets all versions of a named deployment package.

Parameters:

• deploymentPackageName (string) – Name of the DeploymentPackage.

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

DELETE /v3/projects/{projectName}/catalog/deployment_packages/{deploymentPackageName}/versions/{version}

DeleteDeploymentPackage

Deletes a deployment package.

Parameters:

• deploymentPackageName (string) – Name of the DeploymentPackage.

• version (string) – Version of the DeploymentPackage.

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

GET /v3/projects/{projectName}/catalog/deployment_packages/{deploymentPackageName}/versions/{version}

GetDeploymentPackage

Gets a specific deployment package.

Parameters:

• deploymentPackageName (string) – Name of the DeploymentPackage.

• version (string) – Version of the DeploymentPackage.

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

PUT /v3/projects/{projectName}/catalog/deployment_packages/{deploymentPackageName}/versions/{version}

UpdateDeploymentPackage

Updates a deployment package.

Parameters:

• deploymentPackageName (string) – Name of the DeploymentPackage.

• version (string) – Version of the DeploymentPackage.

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

POST /v3/projects/{projectName}/catalog/import

Import

Allows importing a deployment package from a Helm Chart. This is done as a single invocation with the URL

of the asset to be imported.

Parameters:

• projectName (string) – unique projectName for the resource

Query Parameters:

• url (string) – Required URL of Helm Chart to import

• username (string) – Optional username for downloading from the URL

• authToken (string) – Optional authentication token or password for downloading from the URL

• chartValues (string) – Optional raw byte value containing the chart values as raw YAML bytes.

• includeAuth (boolean) – If true and a username/auth_token is specified then they will be included in the generated Registry object.

• generateDefaultValues (boolean) – If true and chart_values is not set, then the values.yaml will be extracted and used to generate default profile values.

• generateDefaultParameters (boolean) – Generates default parameters from the values, from chart_values or from generate_default_values as appropriate.

• namespace (string) – Optional namespace

Status Codes:

• 200 OK – OK

GET /v3/projects/{projectName}/catalog/registries

ListRegistries

Gets a list of registries.

Parameters:

• projectName (string) – unique projectName for the resource

Query Parameters:

• orderBy (string) – Names the field to be used for ordering the returned results.

• filter (string) – Expression to use for filtering the results.

• pageSize (integer) – Maximum number of items to return.

• offset (integer) – Index of the first item to return.

• showSensitiveInfo (boolean) – Request that sensitive information, such as username, auth_token, and CA certificates are included in the response.

Status Codes:

• 200 OK – OK

POST /v3/projects/{projectName}/catalog/registries

CreateRegistry

Creates a new registry.

Parameters:

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

DELETE /v3/projects/{projectName}/catalog/registries/{registryName}

DeleteRegistry

Deletes a registry.

Parameters:

• registryName (string) – Name of the registry.

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

GET /v3/projects/{projectName}/catalog/registries/{registryName}

GetRegistry

Gets a specific registry.

Parameters:

• registryName (string) – Name of the registry.

• projectName (string) – unique projectName for the resource

Query Parameters:

• showSensitiveInfo (boolean) – Request that sensitive information, such as username, auth_token, and CA certificates are included in the response.

Status Codes:

• 200 OK – OK

PUT /v3/projects/{projectName}/catalog/registries/{registryName}

UpdateRegistry

Updates a registry.

Parameters:

• registryName (string) – Name of the Registry.

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

POST /v3/projects/{projectName}/catalog/uploads

UploadCatalogEntities

Allows uploading of a YAML file containing various application catalog entities. Multiple RPC invocations

tagged with the same upload session ID can be used to upload multiple files and to create or update several catalog entities as a single transaction.

Parameters:

• projectName (string) – unique projectName for the resource

Query Parameters:

• sessionId (string) – First upload request in the batch must not specify session ID. Subsequent upload requests must copy the session ID from the previously issued response.

• uploadNumber (integer) – Deprecated: Upload number must increase sequentially, starting with 1.

• lastUpload (boolean) – Must be set to ‘true’ to perform load of all entity files uploaded as part of this session.

Status Codes:

• 200 OK – OK

Utilities API

Download the App Catalog Utilities API in OpenAPI YAML format

GET /v3/projects/{projectName}/catalog/charts

GetRegistryCharts

Gets a list of registry chart names of chart versions.

Parameters:

• projectName (string) – unique projectName for the resource

Query Parameters:

• registry (string) – Names the HELM registry to be queried

• chart (string) – Optional name of the chart whose version list is desired.

Status Codes:

• 200 OK – OK

GET /v3/projects/{projectName}/catalog/deployment_packages/{deploymentPackageName}/versions/{version}/download

DownloadDeploymentPackage

Gets a specific deployment package and downloads it as a tarball.

Parameters:

• deploymentPackageName (string) – Name of the DeploymentPackage.

• version (string) – Version of the DeploymentPackage.

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK

POST /v3/projects/{projectName}/catalog/upload

BulkCatalogUpload

Allows uploading of a YAML files containing various application catalog entities.

Parameters:

• projectName (string) – unique projectName for the resource

Status Codes:

• 200 OK – OK