Skip to main contentlogoCreated with Sketch.
  • Start for free

    • Introduction

    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 Working with 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{},
)

    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 the account settings

    Get the account level settings for the account for private catalog

    Get the account level settings for the account for private catalog.

    Get the account level settings for the account for private catalog.

    Get the account level settings for the account for private catalog.

    Get the account level settings for the account for private catalog.

    GET /catalogaccount
    (catalogManagement *CatalogManagementV1) GetCatalogAccount(getCatalogAccountOptions *GetCatalogAccountOptions) (result *Account, response *core.DetailedResponse, err error)
    ServiceCall<Account> getCatalogAccount()
    getCatalogAccount(params, [callback()])
    get_catalog_account(self, **kwargs)

    Request

    No Request Parameters

    This method does not accept any request parameters.

    No Request Parameters

    This method does not accept any request parameters.

    No Request Parameters

    This method does not accept any request parameters.

    No Request Parameters

    This method does not accept any request parameters.

    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

    Account

    Account information.

    Account

    Account information.

    Account

    Account information.

    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.

    Set the account settings

    PUT /catalogaccount
    (catalogManagement *CatalogManagementV1) UpdateCatalogAccount(updateCatalogAccountOptions *UpdateCatalogAccountOptions) (response *core.DetailedResponse, err error)
    ServiceCall<Void> updateCatalogAccount(UpdateCatalogAccountOptions updateCatalogAccountOptions)
    updateCatalogAccount(params, [callback()])
    update_catalog_account(self, id=None, account_filters=None, **kwargs)

    Request

    Instantiate the UpdateCatalogAccountOptions struct and set the fields to provide parameter values for the UpdateCatalogAccount method.

    Use the UpdateCatalogAccountOptions.Builder to create a UpdateCatalogAccountOptions object that contains the parameter values for the updateCatalogAccount method.

    Request Body

    Account

    Account information

    UpdateCatalogAccountOptions

    The UpdateCatalogAccount options.

    UpdateCatalogAccountOptions

    The updateCatalogAccount options.

    parameters

    • id
      string

      Account identification.

    • Filters

      Filters for account and catalog filters.

    parameters

    • id
      str

      Account identification.

    • Filters

      Filters for account and catalog filters.

    • 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 the audit log(s) for catalog account.

    Get the audit log(s) for catalog account.

    GET /catalogaccount/audit

    Request

    Query Parameters

    • id
      string

      Log identification.

    Response

    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 the accumulated filters of the account and of the catalogs you have access to.

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

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

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

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

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

    GET /catalogaccount/filters
    (catalogManagement *CatalogManagementV1) GetCatalogAccountFilters(getCatalogAccountFiltersOptions *GetCatalogAccountFiltersOptions) (result *AccumulatedFilters, response *core.DetailedResponse, err error)
    ServiceCall<AccumulatedFilters> getCatalogAccountFilters(GetCatalogAccountFiltersOptions getCatalogAccountFiltersOptions)
    getCatalogAccountFilters(params, [callback()])
    get_catalog_account_filters(self, catalog=None, **kwargs)

    Request

    Instantiate the GetCatalogAccountFiltersOptions struct and set the fields to provide parameter values for the GetCatalogAccountFilters method.

    Use the GetCatalogAccountFiltersOptions.Builder to create a GetCatalogAccountFiltersOptions object that contains the parameter values for the getCatalogAccountFilters method.

    Query Parameters

    • catalog
      string

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

    GetCatalogAccountFiltersOptions

    The GetCatalogAccountFilters options.

    GetCatalogAccountFiltersOptions

    The getCatalogAccountFilters options.

    parameters

    • catalog
      string

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

    parameters

    • catalog
      str

      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.

    AccumulatedFilters

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

    AccumulatedFilters

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

    AccumulatedFilters

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

    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

    List the available catalogs for a given account

    List the available catalogs for a given account.

    List the available catalogs for a given account.

    List the available catalogs for a given account.

    List the available catalogs for a given account.

    GET /catalogs
    (catalogManagement *CatalogManagementV1) ListCatalogs(listCatalogsOptions *ListCatalogsOptions) (result *CatalogSearchResult, response *core.DetailedResponse, err error)
    ServiceCall<CatalogSearchResult> listCatalogs()
    listCatalogs(params, [callback()])
    list_catalogs(self, **kwargs)

    Request

    No Request Parameters

    This method does not accept any request parameters.

    No Request Parameters

    This method does not accept any request parameters.

    No Request Parameters

    This method does not accept any request parameters.

    No Request Parameters

    This method does not accept any request parameters.

    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

    CatalogSearchResult

    Paginated catalog search result.

    CatalogSearchResult

    Paginated catalog search result.

    CatalogSearchResult

    Paginated catalog search result.

    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

    Create a catalog for a given account.

    Create a catalog for a given account.

    Create a catalog for a given account.

    Create a catalog for a given account.

    POST /catalogs
    (catalogManagement *CatalogManagementV1) CreateCatalog(createCatalogOptions *CreateCatalogOptions) (result *Catalog, response *core.DetailedResponse, err error)
    ServiceCall<Catalog> createCatalog(CreateCatalogOptions createCatalogOptions)
    createCatalog(params, [callback()])
    create_catalog(self, id=None, rev=None, label=None, short_description=None, catalog_icon_url=None, tags=None, url=None, crn=None, offerings_url=None, features=None, disabled=None, created=None, updated=None, resource_group_id=None, owning_account=None, catalog_filters=None, syndication_settings=None, **kwargs)

    Request

    Instantiate the CreateCatalogOptions struct and set the fields to provide parameter values for the CreateCatalog method.

    Use the CreateCatalogOptions.Builder to create a CreateCatalogOptions object that contains the parameter values for the createCatalog method.

    Request Body

    Catalog

    Catalog information

    CreateCatalogOptions

    The CreateCatalog options.

    CreateCatalogOptions

    The createCatalog options.

    parameters

    • id
      string

      Unique ID.

    • rev
      string

      Cloudant revision.

    • label
      string

      Display Name in the requested language.

    • shortDescription
      string

      Description in the requested language.

    • catalogIconUrl
      string

      URL for an icon associated with this catalog.

    • tags
      string[]

      List of tags associated with this catalog.

    • url
      string

      The url for this specific catalog.

    • crn
      string

      CRN associated with the catalog.

    • offeringsUrl
      string

      URL path to offerings.

    • features

      List of features associated with this catalog.

    • disabled
      boolean

      Denotes whether a catalog is disabled.

    • created
      string

      The date'time this catalog was created.

    • updated
      string

      The date'time this catalog was last updated.

    • resourceGroupId
      string

      Resource group id the catalog is owned by.

    • owningAccount
      string

      Account that owns catalog.

    • Filters

      Filters for account and catalog filters.

    • SyndicationResource

      Feature information.

    parameters

    • id
      str

      Unique ID.

    • rev
      str

      Cloudant revision.

    • label
      str

      Display Name in the requested language.

    • short_description
      str

      Description in the requested language.

    • catalog_icon_url
      str

      URL for an icon associated with this catalog.

    • tags
      List[str]

      List of tags associated with this catalog.

    • url
      str

      The url for this specific catalog.

    • crn
      str

      CRN associated with the catalog.

    • offerings_url
      str

      URL path to offerings.

    • features

      List of features associated with this catalog.

    • disabled
      bool

      Denotes whether a catalog is disabled.

    • created
      datetime

      The date'time this catalog was created.

    • updated
      datetime

      The date'time this catalog was last updated.

    • resource_group_id
      str

      Resource group id the catalog is owned by.

    • owning_account
      str

      Account that owns catalog.

    • Filters

      Filters for account and catalog filters.

    • SyndicationResource

      Feature 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

    Catalog

    Catalog information.

    Catalog

    Catalog information.

    Catalog

    Catalog information.

    Catalog

    Catalog information.

    Status Code

    • 201

      Successful creation

    • 401

      Unauthorized

    • 403

      No Permissions

    No Sample Response

    This method does not specify any sample responses.

    Get a catalog

    Get a catalog

    Get a catalog.

    Get a catalog.

    Get a catalog.

    Get a catalog.

    GET /catalogs/{catalog_identifier}
    (catalogManagement *CatalogManagementV1) GetCatalog(getCatalogOptions *GetCatalogOptions) (result *Catalog, response *core.DetailedResponse, err error)
    ServiceCall<Catalog> getCatalog(GetCatalogOptions getCatalogOptions)
    getCatalog(params, [callback()])
    get_catalog(self, catalog_identifier, **kwargs)

    Request

    Instantiate the GetCatalogOptions struct and set the fields to provide parameter values for the GetCatalog method.

    Use the GetCatalogOptions.Builder to create a GetCatalogOptions object that contains the parameter values for the getCatalog method.

    Path Parameters

    • catalog_identifier
      string

      Catalog identifier

    GetCatalogOptions

    The GetCatalog options.

    GetCatalogOptions

    The getCatalog options.

    parameters

    • catalogIdentifier
      string

      Catalog identifier.

    parameters

    • catalog_identifier
      str

      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

    Catalog

    Catalog information.

    Catalog

    Catalog information.

    Catalog

    Catalog information.

    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 a catalog

    Update a catalog

    Update a catalog.

    Update a catalog.

    Update a catalog.

    Update a catalog.

    PUT /catalogs/{catalog_identifier}
    (catalogManagement *CatalogManagementV1) ReplaceCatalog(replaceCatalogOptions *ReplaceCatalogOptions) (result *Catalog, response *core.DetailedResponse, err error)
    ServiceCall<Catalog> replaceCatalog(ReplaceCatalogOptions replaceCatalogOptions)
    replaceCatalog(params, [callback()])
    replace_catalog(self, catalog_identifier, id=None, rev=None, label=None, short_description=None, catalog_icon_url=None, tags=None, url=None, crn=None, offerings_url=None, features=None, disabled=None, created=None, updated=None, resource_group_id=None, owning_account=None, catalog_filters=None, syndication_settings=None, **kwargs)

    Request

    Instantiate the ReplaceCatalogOptions struct and set the fields to provide parameter values for the ReplaceCatalog method.

    Use the ReplaceCatalogOptions.Builder to create a ReplaceCatalogOptions object that contains the parameter values for the replaceCatalog method.

    Path Parameters

    • catalog_identifier
      string

      Catalog identifier

    Request Body

    Catalog

    Catalog information

    ReplaceCatalogOptions

    The ReplaceCatalog options.

    ReplaceCatalogOptions

    The replaceCatalog options.

    parameters

    • catalogIdentifier
      string

      Catalog identifier.

    • id
      string

      Unique ID.

    • rev
      string

      Cloudant revision.

    • label
      string

      Display Name in the requested language.

    • shortDescription
      string

      Description in the requested language.

    • catalogIconUrl
      string

      URL for an icon associated with this catalog.

    • tags
      string[]

      List of tags associated with this catalog.

    • url
      string

      The url for this specific catalog.

    • crn
      string

      CRN associated with the catalog.

    • offeringsUrl
      string

      URL path to offerings.

    • features

      List of features associated with this catalog.

    • disabled
      boolean

      Denotes whether a catalog is disabled.

    • created
      string

      The date'time this catalog was created.

    • updated
      string

      The date'time this catalog was last updated.

    • resourceGroupId
      string

      Resource group id the catalog is owned by.

    • owningAccount
      string

      Account that owns catalog.

    • Filters

      Filters for account and catalog filters.