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 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-cloud/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-cloud/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 ibm-platform-services

or

easy_install --upgrade ibm-platform-services

GitHub

https://github.com/IBM/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:

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

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.

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.

Catalog Management | IBM Cloud API Docs