Skip to main contentlogoCreated with Sketch.
  • Start for free

    • Introduction

    Last updated: 2021-04-13

    With the catalog management service, you can define the way users in your account can interact with the IBM Cloud® catalog and the private catalogs that you've created. You can use private catalogs to centrally manage access to products. For more information, see Customizing what's available in your private catalogs.

    API endpoint

    https://cm.globalcatalog.cloud.ibm.com/api/v1-beta

    The code examples on this tab use the client library that is provided for Java.

    Maven

    <dependency>
    <groupId>com.ibm.cloud</groupId>
    <artifactId>platform-services</artifactId>
    <version>0.8.0</version>
</dependency>

    Gradle

    'com.ibm.cloud:platform-services:0.8.0'

    GitHub

    https://github.ibm.com/ibmcloud/platform-services-java-sdk

    API endpoint

    https://cm.globalcatalog.cloud.ibm.com/api/v1-beta

    Creating an instance of the Catalog Management service using the Java SDK is shown below.

    Authentication can be specified via environment variables.

    export CATALOG_MANAGEMENT_AUTH_TYPE=iam
export CATALOG_MANAGEMENT_APIKEY={apikey}

    import com.ibm.cloud.platform_services.catalog_management.v1.*;
import com.ibm.cloud.sdk.core.http.Response;

    CatalogManagement service = CatalogManagement.newInstance();

    The code examples on this tab use the client library that is provided for Node.js.

    Installation

    npm i ibm-platform-services

    GitHub

    https://github.ibm.com/ibmcloud/platform-services-node-sdk

    API endpoint

    https://cm.globalcatalog.cloud.ibm.com/api/v1-beta

    Creating an instance of the Catalog Management service using the Node.js SDK is shown below.

    Authentication can be specified via environment variables.

    export CATALOG_MANAGEMENT_AUTH_TYPE=iam
export CATALOG_MANAGEMENT_APIKEY={apikey}

    const CatalogManagementV1 = require('ibm-platform-services/catalog-management/v1');

    service = CatalogManagementV1.newInstance();

    The code examples on this tab use the client library that is provided for Python.

    Installation

    To install, use pip or easy_install:

    pip install --upgrade "platform-services>=0.8.0"

    or

    easy_install --upgrade "platform-services>=0.8.0"

    GitHub

    https://github.ibm.com/ibmcloud/platform-services-python-sdk

    API endpoint

    https://cm.globalcatalog.cloud.ibm.com/api/v1-beta

    Creating an instance of the Catalog Management service using the Node.js SDK is shown below.

    Authentication can be specified via environment variables.

    export CATALOG_MANAGEMENT_AUTH_TYPE=iam
export CATALOG_MANAGEMENT_APIKEY={apikey}

    from ibm_platform_services.catalog_management_v1 import *

    service = CatalogManagementV1.new_instance()

    There are a few different ways to download and install the Platform Services Go SDK project for use by your Go application:

    1. Go get command

    Use this command to download and install the Platform Services Go SDK project to allow your Go application to use it:

    go get -u github.ibm.com/ibmcloud/platform-services-go-sdk
    1. Go modules

    If your application is using Go modules, you can add a suitable import to your Go application, like this:

    import (
    "github.ibm.com/ibmcloud/platform-services-go-sdk/catalogmanagementv1"
)

    Next, run go mod tidy to download and install the new dependency and update your Go application's go.mod file.

    1. Dep dependency manager

    If your application is using the dep dependency management tool, you can add a dependency to your Gopkg.toml file. Here is an example:

    [[constraint]]
  name = "github.ibm.com/ibmcloud/platform-services-go-sdk/catalogmanagementv1"
  version = "0.7.0"

    then run 

    dep ensure

    GitHub

    https://github.com/IBM/platform-services-go-sdk

    API endpoint

    https://cm.globalcatalog.cloud.ibm.com/api/v1-beta

    Creating an instance of the Catalog Management service using the Go SDK is shown below.

    Authentication can be specified via environment variables.

    export CATALOG_MANAGEMENT_AUTH_TYPE=iam
export CATALOG_MANAGEMENT_APIKEY={apikey}

    import (
    "github.com/IBM/go-sdk-core/v3/core"
    "github.com/IBM/platform-services-go-sdk/catalogmanagementv1"
)

    service, _ := catalogmanagementv1.NewCatalogManagementV1UsingExternalConfig(
    &catalogmanagementv1.CatalogManagementV1Options{},
)

    Endpoint URLs

    The Catalog Management API uses the following global endpoint URL for all regions. When you call the API, add the path for each method to form the complete API endpoint for your requests.

    https://cm.globalcatalog.cloud.ibm.com

    If you enabled service endpoints in your account, you can send API requests over the IBM Cloud® private network at the following base endpoint URLs. For more information, see Enabling VRF and service endpoints.

    • Private endpoint URL for VPC infrastructure: https://cm.private.globalcatalog.cloud.ibm.com
    • Private endpoint URLs for classic infrastructure:
      • Dallas: https://cm.private.us-south.globalcatalog.cloud.ibm.com
      • Washington DC: https://cm.private.us-east.globalcatalog.cloud.ibm.com

    Example API request

    curl -X {request_method} "https://cm.globalcatalog.cloud.ibm.com/{method_endpoint}"

    Replace {request_method} and {method_endpoint} in this example with the values for your particular API call.

    Error handling

    The Catalog Management API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 type response always indicates success. A 400 type response is a failure, and a 500 type response is an internal system error.

    Methods

    Get catalog account settings

    Get the account level settings for the account for private catalog

    GET /catalogaccount

    Request

    No Request Parameters

    This method does not accept any request parameters.

    • getOptions := service.NewGetCatalogAccountOptions()
_, response, _ := service.GetCatalogAccount(getOptions)
fmt.Println(response)
    • Response<Account> response = service.getCatalogAccount().execute();
System.out.println(response.getResult());
    • response = self.service.get_catalog_account()
print(response)
    • response = await service.getCatalogAccount();
console.log(response);

    Response

    Response Body

    Account

    Account information

    Status Code

    • 200

      Successful response. Your permissions determine what you can see

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Update account settings

    Update the account level settings for the account for private catalog

    PUT /catalogaccount

    Request

    Request Body

    Account

    Account information

    • id := "{id}"
accountFilters := {accountFilters}
updateOptions := service.NewUpdateCatalogAccountOptions()
updateOptions.SetID(id)
updateOptions.AccountFilters(accountFilters)
response, _ := service.UpdateCatalogAccount(updateOptions)
fmt.Println(response)
    • String id = "{id}";
Filters accountFilters = {accountFilters};
UpdateCatalogAccountOptions updateOptions = new UpdateCatalogAccountOptions.Builder().id(id).accountFilters(accountFilters).build();
Response<Void> response = service.updateCatalogAccount(updateOptions).execute();
System.out.println(response.getResult());
    • id = "{id}";
accountFilters = {accountFilters};
response = await service.updateCatalogAccount({ 'id': id, 'accountFilters': accountFilters });
console.log(response);
    • id="{id}"
accountFilters={accountFilters}
response = self.service.update_catalog_account(id=id, account_filters=accountFilters)
print(response)

    Response

    Status Code

    • 200

      Succesful update. Your permissions determine if can update or not.

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Get catalog account audit log

    Get the audit log associated with a catalog account.

    GET /catalogaccount/audit

    Request

    Query Parameters

    • id
      string

      Log identification.

    Response

    Response Body

    AuditLog

    A collection of audit records

    Status Code

    • 200

      Successful response. Your permissions determine what you can see

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Get catalog account filters

    Get the accumulated filters of the account and of the catalogs you have access to.

    GET /catalogaccount/filters

    Request

    Query Parameters

    • catalog
      string

      catalog id. Narrow down filters to the account and just the one catalog.

    • getOptions := service.NewGetCatalogAccountFiltersOptions()
_, response, _ := service.GetCatalogAccountFilters(getOptions)
fmt.Println(response)
    • Response<AccumulatedFilters> response = service.getCatalogAccountFilters().execute();
System.out.println(response.getResult());
    • response = self.service.get_catalog_account_filters()
print(response)
    • response = await service.getCatalogAccountFilters();
console.log(response);

    Response

    Response Body

    AccumulatedFilters

    The accumulated filters for an account. This will return the account filters plus a filter for each catalog the user has access to.

    Status Code

    • 200

      Successful response. Your permissions determine what you can see

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Get list of catalogs

    Retrieves the available catalogs for a given account. This can be used by an unauthenticated user to retrieve the public catalog.

    GET /catalogs

    Request

    No Request Parameters

    This method does not accept any request parameters.

    • listOptions := service.NewListCatalogsOptions()
_, response, _ := service.ListCatalogs(listOptions)
fmt.Println(response)
    • Response<CatalogSearchResult> response = service.listCatalogs().execute();
System.out.println(response.getResult());
    • response = self.service.list_catalogs()
print(response)
    • response = await service.listCatalogs();
console.log(response);

    Response

    Response Body

    CatalogSearchResult

    Paginated catalog search result

    Status Code

    • 200

      Successful response. Your permissions determine what you can see

    No Sample Response

    This method does not specify any sample responses.

    Create a catalog

    Create a catalog for a given account

    POST /catalogs

    Request

    Request Body

    Catalog

    Catalog information

    • label := "{label}"
shortDesc := "{shortDesc}"
createOptions := service.NewCreateCatalogOptions()
createOptions.SetLabel(label)
createOptions.SetShortDescription(shortDesc)
_, response, _ := service.CreateCatalog(createOptions)
fmt.Println(response)
    • String label = "{label}";
String shortDesc = "{shortDesc}";
CreateCatalogOptions createOptions = new CreateCatalogOptions.Builder().label(label).shortDescription(shortDesc).build();
Response<Catalog> response = service.createCatalog(createOptions).execute();
System.out.println(response.getResult());
    • label = "{label}"
shortDesc = "{shortDesc}"
response = self.service.create_catalog(label=label, short_description=shortDesc)
print(response)
    • label = "{label}";
shortDesc = "{shortDesc}";
response = await service.createCatalog({ 'label': label, 'shortDescription': shortDesc });
console.log(response);

    Response

    Response Body

    Catalog

    Catalog information

    Status Code

    • 201

      New catalog created successfully

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Get catalog

    Get a catalog. This can also be used by an unauthenticated user to get the public catalog.

    GET /catalogs/{catalog_identifier}

    Request

    Path Parameters

    • catalog_identifier
      string

      Catalog identifier

    • id := "{id}"
getOptions := service.NewGetCatalogOptions(id)
_, response, _ := service.GetCatalog(getOptions)
fmt.Println(response)
    • String id = "{id}";
GetCatalogOptions getOptions = new GetCatalogOptions.Builder().catalogIdentifier(id).build();
Response<Catalog> response = service.getCatalog(getOptions).execute();
System.out.println(response.getResult());
    • id = "{id}"
response = self.service.get_catalog(catalog_identifier=id)
print(response)
    • id = "{id}";
response = await service.getCatalog({ 'catalogIdentifier': id });
console.log(response);

    Response

    Response Body

    Catalog

    Catalog information

    Status Code

    • 200

      Successful Result

    • 401

      Unauthorized

    • 403

      No Permissions

    • 404

      No such catalog id

    No Sample Response

    This method does not specify any sample responses.

    Update catalog

    Update a catalog

    PUT /catalogs/{catalog_identifier}

    Request

    Path Parameters

    • catalog_identifier
      string

      Catalog identifier

    Request Body

    Catalog

    Catalog information

    • id := "{id}"
label := "{label}"
shortDesc := "{shortDesc}"
replaceOptions := service.NewReplaceCatalogOptions(id)
replaceOptions.SetCatalogIdentifier(id)
replaceOptions.SetID(id)
replaceOptions.SetLabel(label)
replaceOptions.SetShortDescription(shortDesc)
_, response, _ := service.ReplaceCatalog(replaceOptions)
fmt.Println(response)
    • String id = "{id}";
String label = "{label}";
String shortDesc = "{shortDesc}";
ReplaceCatalogOptions replaceOptions = new ReplaceCatalogOptions.Builder().catalogIdentifier(id).id(id).label(label).shortDescription(shortDesc).build();
Response<Catalog> response = service.replaceCatalog(replaceOptions).execute();
System.out.println(response.getResult());
    • id = "{id}"
label = "{label}"
shortDesc = "{shortDesc}"
response = self.service.replace_catalog(catalog_identifier=id, id=id, label=label, short_description=shortDesc)
print(response)
    • id = "{id}";
label = "{label}";
shortDesc = "{shortDesc}";
response = await service.replaceCatalog({ 'catalogIdentifier': id, 'id': id, 'label': label, 'shortDescription': shortDesc });
console.log(response);

    Response

    Response Body

    Catalog

    Catalog information

    Status Code

    • 200

      Successful Result

    • 401

      Unauthorized

    • 403

      No Permissions

    • 404

      No such catalog id

    No Sample Response

    This method does not specify any sample responses.

    Delete catalog

    Delete a catalog

    DELETE /catalogs/{catalog_identifier}

    Request

    Path Parameters

    • catalog_identifier
      string

      Catalog identifier

    • id := "{id}"
deleteOptions := service.NewDeleteCatalogOptions(id)
response, _ := service.DeleteCatalog(deleteOptions)
fmt.Println(response)
    • String id = "{id}";
DeleteCatalogOptions deleteOptions = new DeleteCatalogOptions.Builder().catalogIdentifier(id).build();
Response<Void> response = service.deleteCatalog(deleteOptions).execute();
System.out.println(response.getResult());
    • id = "{id}"
response = self.service.delete_catalog(catalog_identifier=id, id=id)
print(response)
    • id = "{id}";
response = await service.deleteCatalog({ 'catalogIdentifier': id, 'id': id });
console.log(response);

    Response

    Status Code

    • 200

      Successful Result

    • 401

      Unauthorized

    • 403

      No Permissions

    • 404

      No such catalog

    No Sample Response

    This method does not specify any sample responses.

    Get catalog audit log

    Get the audit log associated with a catalog.

    GET /catalogs/{catalog_identifier}/audit

    Request

    Path Parameters

    • catalog_identifier
      string

      Catalog identifier

    Query Parameters

    • id
      string

      Log identification.

    Response

    Response Body

    AuditLog

    A collection of audit records

    Status Code

    • 200

      Successful response. Your permissions determine what you can see

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Get enterprise settings

    Get the enterprise settings for the specified enterprise ID

    GET /enterprises/{enterprise_id}

    Request

    Path Parameters

    • enterprise_id
      string

      Enterprise identification

    • id := "{id}"
getOptions := service.NewGetEnterpriseOptions(id)
_, response, _ := service.GetEnterprise(getOptions)
fmt.Println(response)
    • String id = "{id}";
GetEnterpriseOptions getOptions = new GetEnterpriseOptions.Builder().enterpriseId(id).build();
Response<Enterprise> response = service.getEnterprise(getOptions).execute();
System.out.println(response.getResult());
    • id = "{id}";
response = await service.getEnterprise({ 'enterpriseId': id });
console.log(response);
    • id = "{id}"
response = self.service.get_enterprise(enterprise_id=id)
print(response)

    Response

    Response Body

    Enterprise

    Enterprise account information

    Status Code

    • 200

      Successful response. Your permissions determine what you can see

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Update enterprise settings

    Update the settings for an enterprise

    PUT /enterprises/{enterprise_id}

    Request

    Path Parameters

    • enterprise_id
      string

      Enterprise identification

    Request Body

    Enterprise

    Enterprise account information

    • id = "{id}"
revision = "{revision}"
accountFilters = "{accountFilters}"
accountGroups = "{accountGroups}"
response = self.service.replace_enterprise(enterprise_id=id, id=id, rev=revision, account_filters= accountFilters, account_groups=accountGroups)
print(response)
    • id := "{id}"
revision := "{revision}"
accountFilters := {accountFilters}
replaceOptions := {replaceOptions}
replaceOptions := service.NewReplaceEnterpriseOptions(id)
replaceOptions.SetID(id)
replaceOptions.SetRev(revision)
replaceOptions.SetAccountFilters(accountFilters)
replaceOptions.SetAccountGroups(accountGroups)
response, _ := service.ReplaceEnterprise(replaceOptions)
fmt.Println(response)
    • String id = "{id}";
String revision = "{revision}";
String accountFilters = {accountFilters};
String accountGroups = {accountGroups};
ReplaceCatalogOptions replaceOptions = new ReplaceEnterpriseOptions.Builder().enterpriseId(id).id(id).rev(revision).accountFilters(accountFilters).accountGroups(accountGroups).build();
Response<Catalog> response = service.replaceEnterprise(replaceOptions).execute();
System.out.println(response.getResult());
    • id = "{id}";
revision = "{revision}";
accountFilters = {accountFilters};
accountGroups = {accountGroups};
response = await service.replaceEnterprise({ 'enterpriseId': id, 'id': id, 'rev': revision, 'accountFilters': accountFilters, 'accountGroups': accountGroups });
console.log(response);

    Response

    Status Code

    • 200

      Successful update. Your permissions determine if can update or not.

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Get enterprise audit log

    Get the audit log associated with an enterprise.

    GET /enterprises/{enterprise_id}/audit

    Request

    Path Parameters

    • enterprise_id
      string

      Enterprise identification

    Query Parameters

    • id
      string

      Log identification.

    Response

    Response Body

    AuditLog

    A collection of audit records

    Status Code

    • 200

      Successful response. Your permissions determine what you can see

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Get consumption offerings

    Retrieve the available offerings from both public and from the account that currently scoped for consumption. These copies cannot be used for updating. They are not complete and only return what is visible to the caller. This can be used by an unauthenticated user to retreive publicly available offerings.

    GET /offerings

    Request

    Query Parameters

    • digest
      boolean

      true - Strip down the content of what is returned. For example don't return the readme. Makes the result much smaller. Defaults to false.

    • catalog
      string

      catalog id. Narrow search down to just a particular catalog. It will apply the catalog's public filters to the public catalog offerings on the result.

    • select
      string

      What should be selected. Default is 'all' which will return both public and private offerings. 'public' returns only the public offerings and 'private' returns only the private offerings.

      Allowable values: [all,public,private]

    • includeHidden
      boolean

      true - include offerings which have been marked as hidden. The default is false and hidden offerings are not returned.

    • limit
      integer

      number or results to return

      Constraints: value ≤ 1000

      Default: 100

    • offset
      integer

      number of results to skip before returning values

      Default: 0

    • options := service.NewGetConsumptionOfferingsOptions()
_, response, _ := service.GetConsumptionOfferings(options)
fmt.Println(response)
    • Response<OfferingSearchResult> response = service.getConsumptionOfferings().execute();
System.out.println(response.getResult());
    • response = self.service.get_consumption_offerings()
print(response)
    • response = await service.getConsumptionOfferings();
console.log(response);

    Response

    Response Body

    OfferingSearchResult

    Paginated offering search result

    Status Code

    • 200

      Successful response. Your permissions determine what you can see

    No Sample Response

    This method does not specify any sample responses.

    Get list of offerings

    Retrieve the available offerings in the specified catalog. This can also be used by an unauthenticated user to retreive publicly available offerings.

    GET /catalogs/{catalog_identifier}/offerings

    Request

    Path Parameters

    • catalog_identifier
      string

      Catalog identifier

    Query Parameters

    • digest
      boolean

      true - Strip down the content of what is returned. For example don't return the readme. Makes the result much smaller. Defaults to false.

    • limit
      integer

      The maximum number of results to return

      Constraints: value ≤ 1000

      Default: 100

    • offset
      integer

      The number of results to skip before returning values

      Default: 0

    • name
      string

      Only return results that contain the specified string

    • sort
      string

      The field on which the output is sorted. Sorts by default by label property. Available fields are name, label, created, and updated. By adding - (i.e. -label) in front of the query string, you can specify descending order. Default is ascending order.

    • id := "{id}"
listOptions := service.NewListOfferingsOptions(id)
_, response, _ := service.ListOfferings(listOptions)
fmt.Println(response)
    • String id = "{id}";
ListOfferingsOptions listOptions = new ListOfferingsOptions.Builder().catalogIdentifier(id).build();
Response<OfferingSearchResult> response = service.listOfferings(listOptions).execute();
System.out.println(response.getResult());
    • id = "{id}"
response = self.service.list_offerings(catalog_identifier=id)
print(response)
    • id = "{id}";
name = "{name}";
label = "{label}";
response = await service.listOfferings({ 'catalogIdentifier': id, 'id': id, 'name': name, 'label': label });
console.log(response);

    Response

    Response Body

    OfferingSearchResult

    Paginated offering search result

    Status Code

    • 200

      Successful response. Your permissions determine what you can see

    No Sample Response

    This method does not specify any sample responses.

    Create offering

    Create an offering

    POST /catalogs/{catalog_identifier}/offerings

    Request

    Path Parameters

    • catalog_identifier
      string

      Catalog identifier

    Request Body

    Offering

    Offering information

    • id := "{id}"
name := "{name}"
label := "{label}"
offeringOptions := service.NewCreateOfferingOptions(id)
offeringOptions.SetName(name)
offeringOptions.SetLabel(label)
_, response, _ := service.CreateOffering(offeringOptions)
fmt.Println(response)
    • String id = "{id}";
String name = "{name}";
String label = "{label}";
CreateOfferingOptions offeringOptions = new CreateOfferingOptions.Builder().catalogIdentifier(id).name(name).label(label).build();
Response<Offering> response = service.createOffering(offeringOptions).execute();
System.out.println(response.getResult());
    • id = "{id}"
name = "{name}"
label = "{label}"
response = self.service.create_offering(catalog_identifier=id, name=name, label=label)
print(response)

    • id = "{id}";
name = "{name}";
label = "{label}";
response = await service.createOffering({ 'catalogIdentifier': id, 'id': id, 'name': name, 'label': label });
console.log(response);

    Response

    Response Body

    Offering

    Offering information

    Status Code

    • 201

      New offering created successfully

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Import offering version

    Import new version to offering from a tgz

    POST /catalogs/{catalog_identifier}/offerings/{offering_id}/version

    Request

    Path Parameters

    • catalog_identifier
      string

      Catalog identifier

    • offering_id
      string

      Offering identification

    Query Parameters

    • zipurl
      string

      URL path to zip location. If not specified, must provide content in the body of this call.

    • targetVersion
      string

      The semver value for this new version, if not found in the zip url package content

    • includeConfig
      boolean

      Add all possible configuration values to this version when importing

    • isVSI
      boolean

      Indicates that the current terraform template is used to install a VSI Image

    • repoType
      string

      The type of repository containing this version. Valid values are 'public_git' or 'enterprise_git'

    Request Body

    ImportOfferingBody

    Additional data to be used when importing an offering or version

    • catalogID := "{catalogID}"
offeringID := "{offeringID}"
offeringURL := "{offeringURL}"
importOptions := service.NewImportOfferingVersionOptions(catalogID, offeringID, offeringURL)
_, response, _ := service.ImportOfferingVersion(importOptions)
fmt.Println(response)
    • String catalogID = "{catalogID}";
String offeringID = "{offeringID}";
String offeringURL = "{offeringURL}";
ImportOfferingVersionOptions newOfferingOptions = new ImportOfferingVersionOptions.Builder().catalogIdentifier(catalogID).offeringId(offeringID).zipurl(offeringURL).build();
Response<Offering> response = service.importOfferingVersion(newOfferingOptions).execute();
System.out.println(response.getResult());
    • catalogID = "{catalogID}"
offeringID = "{offeringID}"
offeringURL = "{offeringURL}"
response = self.service.import_offering_version(catalog_identifier=catalogID, offering_id=offeringID, zipurl=offeringURL)
print(response)

    • catalogID = "{catalogID}";
offeringID = "{offeringID}";
offeringURL = "{offeringURL}";
response = await service.importOfferingVersion({ 'catalogIdentifier': catalogID, 'offeringId': offeringID, 'zipurl': offeringURL });
console.log(response);

    Response

    Response Body

    Offering

    Offering information

    Status Code

    • 201

      New version created successfully

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Import offering

    Import a new offering from a tgz

    POST /catalogs/{catalog_identifier}/import/offerings

    Request

    Custom Headers

    • X-Auth-Token
      string

      Authentication token used to access the specified zip file

    Path Parameters

    • catalog_identifier
      string

      Catalog identifier

    Query Parameters

    • zipurl
      string

      URL path to zip location. If not specified, must provide content in this post body.

    • offeringID
      string

      Re-use the specified offeringID during import

    • targetVersion
      string

      The semver value for this new version

    • includeConfig
      boolean

      Add all possible configuration items when creating this version

    • isVSI
      boolean

      Indicates that the current terraform template is used to install a VSI Image

    • repoType
      string

      The type of repository containing this version. Valid values are 'public_git' or 'enterprise_git'

    Request Body

    ImportOfferingBody

    Additional data to be used when importing an offering or version

    • id := "{id}"
offeringURL := "{offeringURL}"
offeringOptions := service.NewImportOfferingOptions(id, offeringURL)
_, response, _ := service.ImportOffering(offeringOptions)
fmt.Println(response)
    • id = "{id}";
offeringURL = "{offeringURL}";
ImportOfferingOptions offeringOptions = new ImportOfferingOptions.Builder().catalogIdentifier(id).zipurl(offeringURL).build();
Response<Offering> response = service.importOffering(offeringOptions).execute();
System.out.println(response.getResult());
    • id = "{id}"
offeringURL = "{offeringURL}"
response = self.service.import_offering(catalog_identifier=id, zipurl=offeringURL)
print(response)

    • id = "{id}";
offeringURL = "{offeringURL}";
response = await service.importOffering({ 'catalogIdentifier': id, 'zipurl': offeringURL });
console.log(response);

    Response

    Response Body

    Offering

    Offering information

    Status Code

    • 201

      New offering created successfully

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Reload offering

    Reload an existing version in offering from a tgz

    PUT /catalogs/{catalog_identifier}/offerings/{offering_id}/reload

    Request

    Path Parameters

    • catalog_identifier
      string

      Catalog identifier

    • offering_id
      string

      Offering identification

    Query Parameters

    • targetVersion
      string

      The semver value for this new version

    • zipurl
      string

      URL path to zip location. If not specified, must provide content in this post body.

    • repoType
      string

      The type of repository containing this version. Valid values are 'public_git' or 'enterprise_git'

    Request Body

    ImportOfferingBody

    Additional data to be used when importing an offering or version

    • catalogID := "{catalogID}"
offeringID := "{offeringID}"
offeringURL := "{offeringURL}"
offeringVersion := "{offeringVersion}"
reloadOptions := service.NewReloadOfferingOptions(catalogID, offeringID, offeringURL, offeringVersion)
_, response, _ := service.ReloadOffering(reloadOptions)
fmt.Println(response)
    • String catalogID = "{catalogID}";
String offeringID = "{offeringID}";
String version = "{version}";
ReloadOfferingOptions reloadOfferingOptions = new ReloadOfferingOptions.Builder().catalogIdentifier(catalogID).offeringId(offeringID).zipurl(offeringID).targetVersion(version).build();
Response<Offering> response = service.reloadOffering(reloadOfferingOptions).execute();
System.out.println(response.getResult());
    • catalogID = "{catalogID}"
offeringID = "{offeringID}"
offeringURL = "{offeringURL}"
version = "{version}"
response = self.service.reload_offering(catalog_identifier=catalogID, offering_id=offeringID, zipurl=offeringURL, target_version=version)
print(response)
    • catalogID = "{catalogID}";
offeringID = "{offeringID}";
offeringURL = "{offeringURL}";
version = "{version}";
response = await service.reloadOffering({'catalogIdentifier': catalogID, 'offeringId': offeringID, 'zipurl': offeringURL, 'targetVersion': version});
console.log(response);

    Response

    Response Body

    Offering

    Offering information

    Status Code

    • 201

      New version created successfully

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Get offering

    Get an offering. This can be used by an unauthenticated user for publicly available offerings.

    GET /catalogs/{catalog_identifier}/offerings/{offering_id}

    Request

    Path Parameters

    • catalog_identifier
      string

      Catalog identifier

    • offering_id
      string

      Offering identification

    • catalogID := "{catalogID}"
offeringID := "{offeringID}"
getOptions := service.NewGetOfferingOptions(catalogID, offeringID)
_, response, _ := service.GetOffering(getOptions)
fmt.Println(response)
    • String catalogID = "{catalogID}";
String offeringID = "{offeringID}";
GetOfferingOptions getOptions = new GetOfferingOptions.Builder().catalogIdentifier(catalogID).offeringId(offeringID).build();
Response<Offering> response = service.getOffering(getOptions).execute();
System.out.println(response.getResult());
    • catalogID = "{catalogID}"
offeringID = "{offeringID}"
response = self.service.get_offering(catalog_identifier=catalogID, offering_id=offeringID)
print(response)
    • catalogID = "{catalogID}";
offeringID = "{offeringID}";
response = await service.getOffering({ 'catalogIdentifier': catalogID, 'offeringId': offeringID });
console.print(response);

    Response

    Response Body

    Offering

    Offering information

    Status Code

    • 200

      Successful Result

    • 401

      Unauthorized

    • 403

      No Permissions

    • 404

      No such catalog/offering

    No Sample Response

    This method does not specify any sample responses.

    Update offering

    Update an offering

    PUT /catalogs/{catalog_identifier}/offerings/{offering_id}

    Request

    Path Parameters

    • catalog_identifier
      string

      Catalog identifier

    • offering_id
      string

      Offering identification

    Request Body

    Offering

    Offering information

    • catalogID := "{catalogID}"
offeringID := "{offeringID}"
label := "{label}"
shortDesc := "{shortDesc}"
revision := "{revision}"
updateOptions := service.NewReplaceOfferingOptions(catalogID, offeringID)
updateOptions.SetID(offeringID)
updateOptions.SetLabel(label)
updateOptions.SetShortDescription(shortDesc)
updateOptions.SetRev(revision)
_, response, _ := service.ReplaceOffering(updateOptions)
fmt.Println(response)
    • String catalogID = "{catalogID}";
String offeringID = "{offeringID}";
String label = "{label}";
String shortDesc = "{shortDesc}";
ReplaceOfferingOptions replaceOptions = new ReplaceOfferingOptions.Builder().catalogIdentifier(catalogID).id(offeringID).offeringId(offeringID).label(label).shortDescription(shortDesc).rev(revision.rev()).build();
Response<Catalog> response = service.replaceOffering(replaceOptions).execute();
System.out.println(response.getResult());
    • catalogID = "{catalogID}"
offeringID = "{offeringID}"
revision = "{revision}"
shortDesc = "{shortDesc}"
response = self.service.replace_offering(catalog_identifier=catalogID, offering_id=offeringID, id=offeringID, rev=revision, label=label, short_description=shortDesc)
print(response)
    • catalogID = "{catalogID}";
offeringID = "{offeringID}";
revision = "{revision}";
label = "{label}";
shortDesc = "{shortDesc}";
response = await service.replaceOffering({'catalogIdentifier': catalogID, 'offeringId': offeringID, 'id': offeringID, 'rev': revision, 'label': label, 'shortDescription': shortDesc});
console.log(response);

    Response

    Response Body

    Offering

    Offering information

    Status Code

    • 200

      Offering was updated successfully

    • 401

      Unauthorized

    • 403

      No Permissions

    • 404

      No such catalog/offering

    No Sample Response

    This method does not specify any sample responses.

    Delete offering

    Delete an offering

    DELETE /catalogs/{catalog_identifier}/offerings/{offering_id}

    Request

    Path Parameters

    • catalog_identifier
      string

      Catalog identifier

    • offering_id
      string

      Offering identification

    • catalogID := "{catalogID}"
offeringID := "{offeringID}"
deleteOptions := service.NewDeleteOfferingOptions(catalogID, offeringID)
response, _ := service.DeleteOffering(deleteOptions)
fmt.Println(response)
    • String catalogID = "{catalogID}";
String offeringID = "{offeringID}";
DeleteOfferingOptions deleteOfferingOptions = new DeleteOfferingOptions.Builder().catalogIdentifier(catalogID).offeringId(offeringID).build();
Response<Void> response = service.deleteOffering(deleteOfferingOptions).execute();
System.out.println(response.getResult());
    • catalogID = "{catalogID}"
offeringID = "{offeringID}"
response = self.service.delete_offering(catalog_identifier=catalogID, offering_id=offeringID)
print(response)
    • catalogID = "{catalogID}";
offeringID = "{offeringID}";
response = await service.deleteOffering({ 'catalogIdentifier': catalogID, 'offeringId': offeringID });
console.log(response);

    Response

    Status Code

    • 200

      Offering was deleted successfully

    • 401

      Unauthorized

    • 403

      No Permissions

    • 404

      No such catalogg

    No Sample Response

    This method does not specify any sample responses.

    Get offering audit log

    Get the audit log associated with an offering.

    GET /catalogs/{catalog_identifier}/offerings/{offering_id}/audit

    Request

    Path Parameters

    • catalog_identifier
      string

      Catalog identifier

    • offering_id
      string

      Offering identifier

    Query Parameters

    • id
      string

      Log identification.

    Response

    Response Body

    AuditLog

    A collection of audit records

    Status Code

    • 200

      Successful response. Your permissions determine what you can see

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Upload icon for offering

    Upload an icon file to be stored in GC. File is uploaded as a binary payload - not as a form

    PUT /catalogs/{catalog_identifier}/offerings/{offering_id}/icon/{file_name}

    Request

    Path Parameters

    • catalog_identifier
      string

      Catalog identifier

    • offering_id
      string

      Offering identification

    • file_name
      string

      Name of the file name that is being uploaded

    • catalogID := "{catalogID}"
offeringID := "{offeringID}"
fileName := "{fileName}"
replaceOptions := service.NewReplaceOfferingIconOptions(catalogID, offeringID, fileName)
_, response, _ := service.ReplaceOfferingIcon(replaceOptions)
fmt.Println(response)
    • String catalogID = "{catalogID}";
String offeringID = "{offeringID}";
String fileName = "{fileName}";
ReplaceOfferingIconOptions replaceOptions = new ReplaceOfferingIconOptions.Builder().catalogIdentifier(catalogID).offeringId(offeringID).fileName(fileName).build();
Response<Offering> response = service.replaceOfferingIcon(replaceOptions).execute();
System.out.println(response.getResult());
    • catalogID = "{catalogID}";
offeringID = "{offeringID}";
fileName = "{fileName}";
response = await service.replaceOfferingIcon({ 'catalogIdentifier': catalogID, 'offeringId': offeringID, 'fileName': fileName });
console.log(response);
    • catalogID = "{catalogID}"
offeringID = "{offeringID}"
fileName = "{fileName}"
response = self.service.replace_offering_icon(catalog_identifier=catalogID, offering_id=offeringID, file_name=fileName)
print(response)

    Response

    Response Body

    Offering

    Offering information

    Status Code

    • 200

      Successful Result

    • 401

      Unauthorized

    • 403

      No Permissions

    • 404

      No such catalog/offering

    No Sample Response

    This method does not specify any sample responses.

    Allow offering to be published

    Approve or disapprove the offering to be allowed to publish to the IBM Public Catalog. Options:

    • allow_request - (Allow requesting to publish to IBM)
    • ibm - (Allow publishing to be visible to IBM only)
    • public - (Allow publishing to be visible to everyone, including IBM)

    If disapprove public, then ibm approval will not be changed. If disapprove ibm then public will automatically be disapproved. if disapprove allow_request then all rights to publish will be removed. This is because the process steps always go first through allow to ibm and then to public. ibm cannot be skipped. Only users with Approval IAM authority can use this. Approvers should use the catalog and offering id from the public catalog since they wouldn't have access to the private offering.'

    POST /catalogs/{catalog_identifier}/offerings/{offering_id}/publish/{approval_type}/{approved}

    Request

    Path Parameters

    • catalog_identifier
      string

      Catalog identifier

    • offering_id
      string

      Offering identification

    • approval_type
      string

      Type of approval, ibm or public

      Allowable values: [allow_request,ibm,public]

    • approved
      string

      Approve (true) or disapprove (false)

      Allowable values: [true,false]

    • catalogID := "{catalogID}"
offeringID := "{offeringID}"
approvalType := "{approvalType}"
approved := "{approved}"
updateOptions := service.NewUpdateOfferingIbmOptions(catalogID, offeringID, approvalType, approved)
_, response, _ := service.UpdateOfferingIbm(updateOptions)
fmt.Println(response)
    • String catalogID = "{catalogID}";
String offeringID = "{offeringID}";
String approvalType = "{approvalType}";
String approved = "{approved}";
UpdateOfferingIbmOptions updateOptions = new UpdateOfferingIbmOptions.Builder().catalogIdentifier(catalogID).offeringId(offeringID).approvalType(approvalType).approved(approved).build();
Response<ApprovalResult> response = service.updateOfferingIbm(updateOptions).execute();
System.out.println(response.getResult());
    • catalogID = "{catalogID}";
offeringID = "{offeringID}";
approvalType = "{approvalType}";
approved = "{approved}";
response = await service.updateOfferingIbm({ 'catalogIdentifier': catalogID, 'offeringId': offeringID, 'approvalType': approvalType, 'approved': approved });
console.log(response);
    • catalogID = "{catalogID}"
offeringID = "{offeringID}"
approvalType = "{approvalType}"
approved = "{approved}"
response = self.service.update_offering_ibm(catalog_identifier=catalogID, offering_id=offeringID, approval_type=approvalType, approved=approved)
print(response)

    Response

    Response Body

    ApprovalResult

    Result of approval

    Status Code

    • 200

      Successful Result

    • 401

      Unauthorized

    • 403

      No Permissions

    • 404

      No such catalog/offering

    No Sample Response

    This method does not specify any sample responses.

    Get version updates

    Get available updates for the specified version

    GET /catalogs/{catalog_identifier}/offerings/{offering_id}/updates

    Request

    Path Parameters

    • catalog_identifier
      string

      Catalog identifier

    • offering_id
      string

      Offering identification

    Query Parameters

    • kind
      string

      The kind of offering (e.g, helm, ova, terraform ...)

    • version
      string

      optionaly provide an existing version to check updates for if one is not given, all version will be returned.

    • cluster_id
      string

      The id of the cluster where this version was installed

    • region
      string

      The region of the cluster where this version was installed

    • resource_group_id
      string

      The resource group id of the cluster where this version was installed

    • namespace
      string

      The namespace of the cluster where this version was installed

    • versionLocator := "{versionLocator}"
getOptions := service.NewGetVersionUpdatesOptions(versionLocator)
_, response, _ := service.GetVersionUpdates(getOptions)
fmt.Println(response)
    • String versionLocator = "{versionLocator}";
GetVersionUpdatesOptions getOptions = new GetVersionUpdatesOptions.Builder().versionLocId(versionLocator).build();
Response<List<VersionUpdateDescriptor>> response = service.getVersionUpdates(getOptions).execute();
System.out.println(response.getResult());
    • versionLocator = "{versionLocator}"
response = self.service.get_offering_updates(version_loc_id=versionLocator)
print(response)

    • versionLocator = "{versionLocator}";
response = await service.getVersionUpdates({ 'versionLocId': versionLocator});
console.log(response);

    Response

    Response Body

    VersionUpdateDescriptor[]

    Indicates if the current version can be upgraded to the version identified by the descriptor

    Status Code

    • 200

      Version Descriptors, sorted newest first

    • 400

      Bad request

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Get version about information

    Get the about information, in markdown, for the current version

    GET /versions/{version_loc_id}/about

    Request

    Path Parameters

    • version_loc_id
      string

      A dotted value of catalogID.versionID

    • versionLocator := "{versionLocator}"
getOptions := service.NewGetVersionAboutOptions(versionLocator)
_, response, _ := service.GetVersionAbout(getOptions)
fmt.Println(response)
    • String versionLocator = "{versionLocator}";
GetVersionAboutOptions getOptions = new GetVersionAboutOptions.Builder().versionLocId(versionLocator).build();
Response<String> response = service.getVersionAbout(getOptions).execute();
System.out.println(response.getResult());
    • versionLocator = "{versionLocator}"
response = self.service.get_offering_about(version_loc_id=versionLocator)
print(response)
    • versionLocator  = "{versionLocator}";
response = await service.getVersionAbout({ 'versionLocId': versionLocator });
console.log(response);

    Response

    Response Body

    string

    Status Code

    • 200

      Successful response. Your permissions determine what you can see

    • 400

      Bad request

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Get version license content

    Get the license content for the specified license ID in the specified version

    GET /versions/{version_loc_id}/licenses/{license_id}

    Request

    Path Parameters

    • version_loc_id
      string

      A dotted value of catalogID.versionID

    • license_id
      string

      The ID of the license, which maps to the file name in the 'licenses' directory of this verions tgz file

    • versionLocator := "{versionLocator}"
id := "{id}"
getOptions := service.NewGetVersionLicenseOptions(versionLocator, id)
response, _ := service.GetVersionLicense(getOptions)
fmt.Println(response)
    • String versionLocator = "{versionLocator}";
GetVersionLicenseOptions getOption = new GetVersionLicenseOptions.Builder().versionLocId(versionLocator).build();
Response<Void> response = service.getVersionLicense(getOption).execute();
System.out.println(response.getResult());
    • versionLocator = "{versionLocator}";
id = "{id}";
response = await service.getVersionLicense({ 'versionLocId': versionLocator, 'licenseId': id });
console.log(response);
    • versionLocator = "{versionLocator}"
id = "{id}"
response = self.service.get_offering_license(version_loc_id=versionLocator, license_id=id)
print(response)

    Response

    Response Body

    string

    Status Code

    • 200

      Successful response. Your permissions determine what you can see

    • 400

      Bad request

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Get version's container images

    Get the list of container images associated with the specified version. The "image_manifest_url" property of the version should be the URL for the image manifest, and the operation will return that content

    GET /versions/{version_loc_id}/containerImages

    Request

    Path Parameters

    • version_loc_id
      string

      A dotted value of catalogID.versionID

    • versionLocator := "{versionLocator}"
getOptions := service.NewGetVersionContainerImagesOptions(versionLocator)
_, response, _ := service.GetVersionContainerImages(getOptions)
fmt.Println(response)
    • String versionLocator = "{versionLocator}";
GetVersionContainerImagesOptions getOption = new GetVersionContainerImagesOptions.Builder().versionLocId(versionLocator).build();
Response<ImageManifest> response = service.getVersionContainerImages(getOption).execute();
System.out.println(response.getResult());
    • versionLocator = "{versionLocator}";
response = await service.getVersionContainerImages({ 'versionLocId': versionLocator});
console.log(response);
    • versionLocator = "{versionLocator}"
response = self.service.get_offering_container_images(version_loc_id=versionLocator)
print(response)

    Response

    Response Body

    ImageManifest

    Image Manifest

    Status Code

    • 200

      Successful response. A list of images

    No Sample Response

    This method does not specify any sample responses.

    Deprecate version

    Deprecate the specified version

    POST /versions/{version_loc_id}/deprecate

    Request

    Path Parameters

    • version_loc_id
      string

      A dotted value of catalogID.versionID

    • versionLocator := "{versionLocator}"
depOptions := service.NewDeprecateVersionOptions(versionLocator)
response, _ := service.DeprecateVersion(depOptions)
fmt.Println(response)
    • String versionLocator = "{versionLocator}";
DeprecateVersionOptions depOptions = new DeprecateVersionOptions.Builder().versionLocId(versionLocator).build();
Response<Void> response = service.deprecateVersion(depOptions).execute();
System.out.println(response.getResult());
    • versionLocator = "{versionLocator}";
response = await service.deprecateVersion({ 'versionLocId': versionLocator});
console.log(response);
    • versionLocator = "{versionLocator}"
response = self.service.deprecate_version(version_loc_id=versionLocator)
print(response)

    Response

    Status Code

    • 202

      Request accepted.

    • 400

      Bad request

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Publish version to account members

    Publish the specified version so it is viewable by account members

    POST /versions/{version_loc_id}/account-publish

    Request

    Path Parameters

    • version_loc_id
      string

      A dotted value of catalogID.versionID

    • versionLocator := "{versionLocator}"
publishOptions := service.NewAccountPublishVersionOptions(versionLocator)
response, _ := service.AccountPublishVersion(publishOptions)
fmt.Println(response)
    • String versionLocator = "{versionLocator}";
AccountPublishVersionOptions publishOption = new AccountPublishVersionOptions.Builder().versionLocId(versionLocator).build();
Response<Void> response = service.accountPublishVersion(publishOption).execute();
System.out.println(response.getResult());
    • versionLocator = "{versionLocator}";
response = await service.accountPublishVersion({ 'versionLocId': versionLocator});
console.log(response);
    • versionLocator = "{versionLocator}"
response = self.service.account_publish_version(version_loc_id=versionLocator)
print(response)

    Response

    Status Code

    • 202

      Request accepted.

    • 400

      Bad request

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Publish version to IBMers in public catalog

    Publish the specified version so that it is visible to IBMers in the public catalog

    POST /versions/{version_loc_id}/ibm-publish

    Request

    Path Parameters

    • version_loc_id
      string

      A dotted value of catalogID.versionID

    • versionLocator := "{versionLocator}"
publishOptions := service.NewIbmPublishVersionOptions(versionLocator)
response, _ := service.IbmPublishVersion(publishOptions)
fmt.Println(response)
    • String versionLocator = "{versionLocator}";
IbmPublishVersionOptions publishOption = new IbmPublishVersionOptions.Builder().versionLocId(versionLocator).build();
Response<Void> response = service.ibmPublishVersion(publishOption).execute();
System.out.println(response.getResult());
    • versionLocator = "{versionLocator}";
response = await service.ibmPublishVersion({ 'versionLocId': versionLocator});
console.log(response);
    • versionLocator = "{versionLocator}"
response = self.service.ibm_publish_version(version_loc_id=versionLocator)
print(response)

    Response

    Status Code

    • 202

      Request accepted.

    • 400

      Bad request

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Publish version to all users in public catalog

    Publish the specified version so it is visible to all users in the public catalog

    POST /versions/{version_loc_id}/public-publish

    Request

    Path Parameters

    • version_loc_id
      string

      A dotted value of catalogID.versionID

    • versionLocator := "{versionLocator}"
publishOptions := service.NewPublicPublishVersionOptions(versionLocator)
response, _ := service.PublicPublishVersion(publishOptions)
fmt.Println(response)
    • String versionLocator = "{versionLocator}";
PublicPublishVersionOptions publishOption = new PublicPublishVersionOptions.Builder().versionLocId(versionLocator).build();
Response<Void> response = service.publicPublishVersion(publishOption).execute();
System.out.println(response.getResult());
    • versionLocator = "{versionLocator}";
response = await service.publicPublishVersion({ 'versionLocId': versionLocator});
console.log(response);
    • versionLocator = "{versionLocator}"
response = self.service.public_publish_version(version_loc_id=versionLocator)
print(response)

    Response

    Status Code

    • 202

      Request accepted.

    • 400

      Bad request

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Commit version

    Commit a working copy of the specified version

    POST /versions/{version_loc_id}/commit

    Request

    Path Parameters

    • version_loc_id
      string

      A dotted value of catalogID.versionID

    • versionLocator := "{versionLocator}"
commitOptions := service.NewCommitVersionOptions(versionLocator)
response, _ := service.commitOptions(publishOptions)
fmt.Println(response)
    • String versionLocator = "{versionLocator}";
CommitVersionOptions commitOptions = new CommitVersionOptions.Builder().versionLocId(versionLocator).build();
Response<Void> response = service.commitVersion(commitOptions).execute();
System.out.println(response.getResult());
    • versionLocator = "{versionLocator}";
response = await service.commitVersion({ 'versionLocId': versionLocator});
console.log(response);
    • versionLocator = "{versionLocator}"
response = self.service.commit_version(version_loc_id=versionLocator)
print(response)

    Response

    Status Code

    • 200

      Working copy was committed successfully

    • 400

      Bad request

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Copy version to new target kind

    Copy the specified version to a new target kind within the same offering

    POST /versions/{version_loc_id}/copy

    Request

    Path Parameters

    • version_loc_id
      string

      A dotted value of catalogID.versionID

    Request Body

    ImportOfferingBody

    Additional data to be used when importing an offering or version

    Response

    Status Code

    • 200

      Version was copied successfully

    • 400

      Bad request

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Create working copy of version

    Create a working copy of the specified version

    POST /versions/{version_loc_id}/workingcopy

    Request

    Path Parameters

    • version_loc_id
      string

      A dotted value of catalogID.versionID

    • versionLocator := "{versionLocator}"
getOptions := service.NewGetVersionWorkingCopyOptions(versionLocator)
_, response, _ := service.GetVersionWorkingCopy(getOptions)
fmt.Println(response)
    • String versionLocator = "{versionLocator}";
GetVersionWorkingCopyOptions getVersion = new GetVersionWorkingCopyOptions.Builder().versionLocId(versionLocator).build();
Response<Void> response = service.getVersionWorkingCopy(getVersion).execute();
System.out.println(response.getResult());
    • versionLocator = "{versionLocator}";
response = await service.getVersionWorkingCopy({ 'versionLocId': versionLocator});
console.log(response);
    • versionLocator = "{versionLocator}"
response = self.service.get_offering_working_copy(version_loc_id=versionLocator)
print(response)

    Response

    Response Body

    Version

    Offering version information

    Status Code

    • 200

      Working copy created successfully

    • 400

      Bad request

    • 401

      Unauthorized

    • 403

      No Permissions

    • 409

      Working Copy already exists

    No Sample Response

    This method does not specify any sample responses.

    Get offering/kind/version 'branch'

    Get the Offering/Kind/Version 'branch' for the specified locator ID

    GET /versions/{version_loc_id}

    Request

    Path Parameters

    • version_loc_id
      string

      A dotted value of catalogID.versionID

    • versionLocator := "{versionLocator}"
versionOptions := service.NewGetVersionOptions(versionLocator)
_, response, _ := service.GetVersion(versionOptions)
fmt.Println(response)
    • String versionLocator = "{versionLocator}";
GetVersionOptions getOptions = new GetVersionOptions.Builder().versionLocId(versionLocator).build();
Response<Offering> response = service.getVersion(getOptions).execute();
System.out.println(response.getResult());
    • versionLocator = "{versionLocator}"
response = self.service.get_version(version_loc_id=versionLocator)
print(response)
    • versionLocator = "{versionLocator}";
response = await service.getVersion({ 'versionLocId': versionLocator });
console.log(response);

    Response

    Response Body

    Offering

    Offering information

    Status Code

    • 200

      Successful response. Your permissions determine what you can see

    No Sample Response

    This method does not specify any sample responses.

    Delete version

    Delete the specified version. If the version is an active version with a working copy, the working copy will be deleted as well.

    DELETE /versions/{version_loc_id}

    Request

    Path Parameters

    • version_loc_id
      string

      A dotted value of catalogID.versionID

    • versionLocator := "{versionLocator}"
deleteOptions := service.NewDeleteVersionOptions(versionLocator)
response, _ := service.DeleteVersion(deleteOptions)
fmt.Println(response)
    • String versionLocator = "{versionLocator}";
deleteOption = new DeleteVersionOptions.Builder().versionLocId(versionLocator).build();
Response<Void> response = service.deleteVersion(deleteOption).execute();
System.out.println(response.getResult());
    • versionLocator = "{versionLocator}"
response = self.service.delete_version(version_loc_id=versionLocator)
print(response)
    • versionLocator = "{versionLocator}";
response = await service.deleteVersion({ 'versionLocId': versionLocator });
console.log(response);

    Response

    Status Code

    • 200

      Version deleted successfully

    • 400

      Bad request

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    List versions

    [deprecated] use 'search_license_versions' operation instead. Search across all accounts for versions, requires global admin permission.

    GET /versions

    Request

    Query Parameters

    • q
      string

      query, for now only "q=entitlement_key:" is supported

    • id := "{id}"
getOptions := service.NewListVersionsOptions(id)
response, _ := service.ListVersions(getOptions)
fmt.Println(response)
    • String id = "{id}";
ListVersionsOptions getVersion = new ListVersionsOptions.Builder().q(id).build();
Response<Void> response = service.listVersions(getVersion).execute();
System.out.println(response.getResult());
    • id = "{id}";
response = await service.listVersions({ 'q': id });
console.log(response);
    • id = "{id}"
response = self.service.list_versions(q=id)
print(response)

    Response

    Status Code

    • 200

      Successful response with a search result of version locators, a dotted value of catalogID.versionID

    No Sample Response

    This method does not specify any sample responses.

    List a repository's entries

    List the available entries from a given repository

    GET /repo/{type}/entries

    Request

    Path Parameters

    • type
      string

      The type of repository (valid repository types: helm)

    Query Parameters

    • repourl
      string

      The URL for the repository's root (e.g https://kubernetes-charts-incubator.storage.googleapis.com)

    • repoType := "{repoType}"
repoURL := "{repoURL}"
getOptions := service.NewGetReposOptions(repoType, repoURL)
_, response, _ := service.GetRepos(getOptions)
fmt.Println(response)
    • String repoType = "{repoType}";
String repoURL = "{repoURL}";
GetReposOptions getOptions = new GetReposOptions.Builder().type(repoType).repourl(repoURL).build();
Response<HelmPackage> response = service.getRepos(getOptions).execute();
System.out.println(response.getResult());
    • repoType = "{repoType}";
repoURL = "{repoURL}";
response = await service.getRepos({ 'repoType': repoType, 'repourl':  repoURL} );
console.log(response);
    • repoType = "{repoType}"
repoURL = "{repoURL}"
response = self.service.get_repos(type=repoType, repourl=repoURL)
print(response)

    Response

    Response Body

    HelmRepoList

    Helm repository metadata

    Status Code

    • 200

      Successful response.

    No Sample Response

    This method does not specify any sample responses.

    Get repository contents

    Get the contents of a given repo

    GET /repo/{type}

    Request

    Path Parameters

    • type
      string

      The type of repository (valid repository types: helm)

    Query Parameters

    • charturl
      string

      The URL for the repository's chart zip file (e.g https://registry.bluemix.net/helm/ibm-charts/charts/ibm-redis-ha-dev-1.0.0.tgz)

    • repoType := "{repoType}"
chartURL := "{chartURL}"
getOptions := service.NewGetRepoOptions(repoType, chartURL)
_, response, _ := service.GetRepo(getOptions)
fmt.Println(response)
    • String repoType = "{repoType}";
String chartURL = "{chartURL}";
GetRepoOptions getOptions = new GetRepoOptions.Builder().type(repoType).charturl(chartURL).build();
Response<HelmPackage> response = service.getRepo(getOptions).execute();
System.out.println(response.getResult());
    • repoType = "{repoType}";
chartURL = "{chartURL}";
response = await service.getRepo({ 'repoType': repoType, 'charturl':  chartURL } );
console.log(response);
    • repoType = "{repoType}"
chartUrl = "{chartUrl}"
response = self.service.get_repo(type=repoType, charturl=chartUrl)
print(response)

    Response

    Response Body

    HelmPackage

    Helm package

    Status Code

    • 200

      Successful response.

    No Sample Response

    This method does not specify any sample responses.

    List Kubernetes clusters

    List Kubernetes clusters

    GET /deploy/kubernetes/clusters

    Request

    Query Parameters

    • limit
      integer

      The maximum number of results to return

      Constraints: value ≤ 1000

      Default: 100

    • offset
      integer

      The number of results to skip before returning values

    • type
      string

      Kubernetes or OpenShift. Default is kubernetes.

    • listOptions := service.NewListClustersOptions()
_, response, _ := service.ListClusters(listOptions)
fmt.Println(response)
    • ListClustersOptions getOptions = new ListClustersOptions.Builder().build();
Response<ClusterSearchResult> response = service.listClusters(getOptions).execute();
System.out.println(response.getResult());
    • response = await service.listClusters();
console.log(response);
    • response = self.service.list_clusters()
print(response)

    Response

    Response Body

    ClusterSearchResult

    Paginated cluster search result

    Status Code

    • 200

      Successful Result

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Get kubernetes cluster

    Get the contents of the specified kubernetes cluster

    GET /deploy/kubernetes/clusters/{cluster_id}

    Request

    Custom Headers

    • X-Auth-Refresh-Token
      string

      IAM Refresh token

    Path Parameters

    • cluster_id
      string

      ID of the cluster

    Query Parameters

    • region
      string

      Region of the cluster

    • clusterID := "{clusterID}"
region := "{region}"
authRefreshToken := "{authRefreshToken}"
getOptions := service.NewGetClusterOptions(clusterID, region, authRefreshToken)
_, response, _ := service.GetCluster(getOptions)
fmt.Println(response)
    • String clusterID = "{clusterID}";
String region = "{region}";
String authRefreshToken = "{authRefreshToken}";
GetClusterOptions getOptions = new GetClusterOptions.Builder().clusterId(clusterID).region(region).xAuthRefreshToken(authRefreshToken).build();
Response<ClusterInfo> response = service.getCluster(getOptions).execute();
System.out.println(response.getResult());
    • clusterID = "{clusterID}";
region = "{region}";
authRefreshToken = "{authRefreshToken}";
response = await service.getCluster({ 'clusterId': clusterID, 'region': region, 'xAuthRefreshToken': authRefreshToken });
console.log(response);
    • clusterID = "{clusterID}"
region = "{region}"
authRefreshToken="{authRefreshToken}"
response = self.service.get_cluster(cluster_id=clusterID, region=region, x_auth_refresh_token=authRefreshToken)
print(response)

    Response

    Response Body

    ClusterInfo

    Cluster information

    Status Code

    • 200

      Successful Result

    • 401

      Unauthorized

    • 403

      No Permissions

    • 404

      No such cluster

    No Sample Response

    This method does not specify any sample responses.

    Get cluster namespaces

    Get the namespaces associated with the specified kubernetes cluster

    GET /deploy/kubernetes/clusters/{cluster_id}/namespaces

    Request

    Custom Headers

    • X-Auth-Refresh-Token
      string

      IAM Refresh token

    Path Parameters

    • cluster_id
      string

      ID of the cluster

    Query Parameters

    • region
      string

      Cluster region

    • limit
      integer

      The maximum number of results to return

      Constraints: value ≤ 1000

      Default: 100

    • offset
      integer

      The number of results to skip before returning values

      Default: 0

    • clusterID := "{clusterID}"
region := "{region}"
authRefreshToken := "{authRefreshToken}"
getOptions := service.NewGetNamespacesOptions(clusterID, region, authRefreshToken)
_, response, _ := service.GetNamespaces(getOptions)
fmt.Println(response)
    • String clusterID = "{clusterID}";
String region = "{region}";
String authRefreshToken = "{authRefreshToken}";
GetNamespacesOptions getOptions = new GetNamespacesOptions.Builder().clusterId(clusterID).region(region).xAuthRefreshToken(authRefreshToken).build();
Response<NamespaceSearchResult> response = service.getNamespaces(getOptions).execute();
System.out.println(response.getResult());
    • clusterID = "{clusterID}";
region = "{region}";
authRefreshToken = "{authRefreshToken}";
response = await service.getNamespaces({ 'clusterId': clusterID, 'region': region, 'xAuthRefreshToken': authRefreshToken });
console.log(response);
    • clusterID = "{clusterID}"
region = "{region}"
authRefreshToken="{authRefreshToken}"
response = self.service.get_namespaces(cluster_id=clusterID, region=region, x_auth_refresh_token=authRefreshToken)
print(response)

    Response

    Response Body

    NamespaceSearchResult

    Paginated list of namespace search results

    Status Code

    • 200

      List of namespaces on the cluster that are visible by the current user

    • 401

      Unauthorized

    • 403

      No Permissions

    • 404

      No such cluster

    No Sample Response

    This method does not specify any sample responses.

    Deploy operators

    Deploy operators on a kubernetes cluster

    POST /deploy/kubernetes/olm/operator

    Request

    Custom Headers

    • X-Auth-Refresh-Token
      string

      IAM Refresh token

    Request Body

    OperatorDeploy

    Cluster request data

    • createOption := service.NewCreateOperatorOptions(authRefreshToken)
createOption.SetNamespaces({namespaces}}
createOption.SetClusterID("{clusterID}")
createOption.SetRegion("{region}")
createOption.SetVersionLocatorID("{versionLocator}")
_, response, _ := service.CreateOperator(createOption)
fmt.Println(response)
    • String namespaces = {namespaces};
String clusterID = "{clusterID}";
String region = "{region}";
String authRefreshToken = "{authRefreshToken}";
String versionLocator = "{versionLocator}";
CreateOperatorOptions createOptions = new CreateOperatorOptions.Builder().namespaces(namespaces).clusterId(clusterID).region(region).xAuthRefreshToken(authRefreshToken).versionLocatorId(versionLocator).build();
Response<List<OperatorDeployResult>> response = service.createOperator(createOptions).execute();
System.out.println(response.getResult());
    • clusterID = "{clusterID}";
region = "{region}";
namespaces = "{namespaces}";
versionLocator = "{versionLocator}";
authRefreshToken = "{authRefreshToken}";
response = await service.createOperator({ 'clusterId': clusterID, 'region': region, 'namespaces': namespaces, 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken });
console.log(response);
    • clusterID = "{clusterID}"
region = "{region}"
namespaces = {namespaces}
authRefreshToken="{authRefreshToken}"
versionLocator = "{versionLocator}"
response = self.service.create_operator(version_locator_id=versionLocator, cluster_id=clusterID, region=region, namespaces=namespaces, x_auth_refresh_token=authRefreshToken)
print(response)

    Response

    Response Body

    OperatorDeployResult[]

    Operator deploy result

    Status Code

    • 200

      Successful Result

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    List operators

    List the operators from a kubernetes cluster

    GET /deploy/kubernetes/olm/operator

    Request

    Custom Headers

    • X-Auth-Refresh-Token
      string

      IAM Refresh token

    Query Parameters

    • cluster_id
      string

      Cluster identification

    • region
      string

      Cluster region

    • version_locator_id
      string

      A dotted value of catalogID.versionID

    • clusterID := "{clusterID}"
region := "{region}"
versionLocator := "{versionLocator}"
authRefreshToken := "{authRefreshToken}"
listOptions := service.NewListOperatorsOptions(authRefreshToken, clusterID, region, versionLocator)
_, response, _ := service.ListOperators(listOptions)
fmt.Println(response)
    • String clusterID = "{clusterID}";
String region = "{region}";
String authRefreshToken = "{authRefreshToken}";
String versionLocator = "{versionLocator}";
ListOperatorsOptions listOptions = new ListOperatorsOptions.Builder().clusterId(clusterID).region(region).xAuthRefreshToken(authRefreshToken).versionLocatorId(versionLocator).build();
Response<List<OperatorDeployResult>> response = service.listOperators(listOptions).execute();
System.out.println(response.getResult());
    • clusterID = "{clusterID}";
region = "{region}";
versionLocator = "{versionLocator}";
authRefreshToken = "{authRefreshToken}";
response = await service.listOperators({ 'clusterId': clusterID, 'region': region, 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken });
console.log(response);
    • clusterID = "{clusterID}"
region = "{region}"
authRefreshToken="{authRefreshToken}"
versionLocator = "{versionLocator}"
response = self.service.list_operators(version_locator_id=versionLocator, cluster_id=clusterID, region=region, x_auth_refresh_token=authRefreshToken)
print(response)

    Response

    Response Body

    OperatorDeployResult[]

    Operator deploy result

    Status Code

    • 200

      Successful Result

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Update operators

    Update the operators on a kubernetes cluster

    PUT /deploy/kubernetes/olm/operator

    Request

    Custom Headers

    • X-Auth-Refresh-Token
      string

      IAM Refresh token

    Request Body

    OperatorDeploy

    Cluster request data

    • replaceOptions := service.NewReplaceOperatorOptions(authRefreshToken)
replaceOptions.SetNamespaces({namespaces}}
replaceOptions.SetClusterID("{clusterID}")
replaceOptions.SetRegion("{region}")
replaceOptions.SetVersionLocatorID("{versionLocator}")
_, response, _ := service.ReplaceOperator(replaceOptions)
fmt.Println(response)
    • String namespaces = {namespaces};
String clusterID = "{clusterID}";
String region = "{region}";
String authRefreshToken = "{authRefreshToken}";
String versionLocator = "{versionLocator}";
ReplaceOperatorOptions replaceOptions = new ReplaceOperatorOptions.Builder().namespaces(namespaces).clusterId(clusterID).region(region).xAuthRefreshToken(authRefreshToken).versionLocatorId(versionLocator).build();
Response<List<OperatorDeployResult>> response = service.replaceOperator(replaceOptions).execute();
System.out.println(response.getResult());
    • clusterID = "{clusterID}";
region = "{region}";
namespaces = "{namespaces}";
versionLocator = "{versionLocator}";
authRefreshToken = "{authRefreshToken}";
response = await service.replaceOperator({ 'clusterId': clusterID, 'region': region, 'namespaces': namespaces, 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken });
console.log(response);
    • clusterID = "{clusterID}"
region = "{region}"
namespaces = {namespaces}
authRefreshToken="{authRefreshToken}"
versionLocator = "{versionLocator}"
response = self.service.replace_operator(version_locator_id=versionLocator, cluster_id=clusterID, region=region, namespaces=namespaces, x_auth_refresh_token=authRefreshToken)
print(response)

    Response

    Response Body

    OperatorDeployResult[]

    Operator deploy result

    Status Code

    • 200

      Successful Result

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Delete operators

    Delete operators from a kubernetes cluster

    DELETE /deploy/kubernetes/olm/operator

    Request

    Custom Headers

    • X-Auth-Refresh-Token
      string

      IAM Refresh token

    Query Parameters

    • cluster_id
      string

      Cluster identification

    • region
      string

      Cluster region

    • version_locator_id
      string

      A dotted value of catalogID.versionID

    • deleteOptions := service.NewDeleteOperatorOptions(authRefreshToken, clusterID, region, versionLocator)
deleteOptions.SetNamespaces({namespaces}}
deleteOptions.SetClusterID("{clusterID}")
deleteOptions.SetRegion("{region}")
deleteOptions.SetVersionLocatorID("{versionLocator}")
_, response, _ := service.ReplaceOperator(deleteOptions)
fmt.Println(response)
    • String clusterID = "{clusterID}";
String region = "{region}";
String authRefreshToken = "{authRefreshToken}";
String versionLocator = "{versionLocator}";
DeleteOperatorOptions deleteOptions = new DeleteOperatorOptions.Builder().clusterId(clusterID).region(region).xAuthRefreshToken(authRefreshToken).versionLocatorId(versionLocator).build();
Response<Void> response = service.deleteOperator(deleteOptions).execute();
System.out.println(response.getResult());
    • clusterID = "{clusterID}";
region = "{region}";
versionLocator = "{versionLocator}";
authRefreshToken = "{authRefreshToken}";
response = await service.deleteOperator({ 'clusterId': clusterID, 'region': region, 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken });
console.log(response);
    • clusterID = "{clusterID}"
region = "{region}"
authRefreshToken="{authRefreshToken}"
versionLocator = "{versionLocator}"
response = self.service.delete_operator(version_locator_id=versionLocator, cluster_id=clusterID, region=region, x_auth_refresh_token=authRefreshToken)
print(response)

    Response

    Status Code

    • 200

      Successful Result

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Install version

    Create an install for the specified version

    POST /versions/{version_loc_id}/install

    Request

    Custom Headers

    • X-Auth-Refresh-Token
      string

      IAM Refresh token

    Path Parameters

    • version_loc_id
      string

      A dotted value of catalogID.versionID

    Request Body

    DeployRequestBody

    Cluster request data